Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/prefixes

prefixes

npm versionnpm downloads Twitter Follow

This project is part of the @thi.ng/umbrella monorepo.

About

50+ Linked Data vocabulary prefixes and their namespace URLs.

Status

STABLE - used in production

Installation

yarn add @thi.ng/prefixes
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/prefixes?module" crossorigin></script>

// UMD
<script src="https://unpkg.com/@thi.ng/prefixes/lib/index.umd.js" crossorigin></script>

Package sizes (gzipped, pre-treeshake): ESM: 998 bytes / CJS: 1.21 KB / UMD: 1.01 KB

Dependencies

None

API

Generated API docs

This package only contains constants, no actual code. Please see source code for full list provided.

Note: some namespace URIs exist in two flavors - for RDF vocab and as XML namespace. The latter versions are always prefixed with XML_, e.g.:

import { xsd, XML_XSD } from "@thi.ng/prefixes";

xsd     // http://www.w3.org/2001/XMLSchema#
XML_XSD // http://www.w3.org/2001/XMLSchema

Usage with @thi.ng/hiccup

All current @thi.ng/hiccup consumers/processors support RDFa attributes and specifically allow the prefix attrib value to be given as object of prefixes. This allows for very compact prefix definitions like so:

import { serialize } from "@thi.ng/hiccup";
import { article, body, div, h1, html } from "@thi.ng/hiccup-html";
import { dc, schema } from "@thi.ng/prefixes";

serialize(
    html({ lang: "en" },
        body({ prefix: { dc, schema } },
            article({ resource: "/posts/hello-world", typeof: "schema:BlogPosting"},
                h1({ property: "dc:title" }, "Hello World"),
                div({ property: "schema:articleBody" }, "...")
            )
        )
    )
);

Serialized HTML/RDFa result:

<html lang="en">
    <body prefix="dc: http://purl.org/dc/elements/1.1/ schema: http://schema.org/">
        <article resource="/posts/hello-world" typeof="schema:BlogPosting">
            <h1 property="dc:title">Hello World</h1>
            <div property="schema:articleBody">...</div>
        </article>
    </body>
</html>

Authors

Karsten Schmidt

License

© 2020 Karsten Schmidt // Apache Software License 2.0

Generated using TypeDoc