readme.md

a-rel

List of values for rel on <a> and <area> elements according to Microformats.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • aRel
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This package lists values that are allowed in rel attributes on <a> and <area> elements. These values come from Microformats.

When should I use this?

Use this package for a list of Microformats extensions on <a> and <area> elements. See link-rel for a list of Microformats extensions to <link> and html-link-types if you specifically need to check which values are allowed by the HTML spec.

Install

This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:

npm install a-rel

In Deno with esm.sh:

import {aRel} from 'https://esm.sh/a-rel@3'

In browsers with esm.sh:

<script type="module">
  import {aRel} from 'https://esm.sh/a-rel@3?bundle'
</script>

Use

import {aRel} from 'a-rel'

console.log(aRel.slice(0, 10))

Yields:

[
  'about',
  'acquaintance',
  'alternate',
  'amphtml',
  'appendix',
  'archived',
  'attachment',
  'bookmark',
  'canonical',
  'category'
]

API

This package exports the identifier aRel. There is no default export.

aRel

List of lowercase types (Array<string>).

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe.

Related

• wooorm/html-link-types — list of link types for rel according to HTML
• wooorm/link-rel — list of link types for rel on link
• wooorm/aria-attributes — list of ARIA attributes
• wooorm/html-dangerous-encodings — list of dangerous HTML character encoding labels
• wooorm/html-encodings — list of HTML character encoding labels
• wooorm/meta-name — list of values for name on meta
• wooorm/web-namespaces — map of web namespaces

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer