diff --git a/demo/api.md b/demo/api.md index 0d7b7b9..69b2d1b 100644 --- a/demo/api.md +++ b/demo/api.md @@ -23,26 +23,28 @@ side of a page to navigate to seperate pages or different sections within the sa ## Properties -| Property | Attribute | Type | Default | Description | -|------------------|------------------|-----------|---------|--------------------------------------------------| -| [download](#download) | `download` | `Boolean` | false | Specifies that the target will be downloaded when a user clicks on the hyperlink. | -| [fluid](#fluid) | `fluid` | `Boolean` | | Modifier for `type="cta"` fluid-width UI option. | -| [href](#href) | `href` | `String` | | Specifies the URL of the page link. | -| [ondark](#ondark) | `ondark` | `Boolean` | false | Specifies dark theme use of hyperlink. | -| [referrerpolicy](#referrerpolicy) | `referrerpolicy` | `Boolean` | | Sets `strict-origin-when-cross-origin` to send a full URL when performing a same-origin request, only sends the origin when the protocol security level stays the same (HTTPS→HTTPS), and sends no header to a less secure destination (HTTPS→HTTP). | -| [rel](#rel) | `rel` | `String` | | Specifies the relationship between the current document and the linked document. | -| [relative](#relative) | `relative` | `Boolean` | false | Add flag to disable auto URL re-write feature. | -| [role](#role) | `role` | `String` | | Use for aria roles; currently supports `button` for extended experiences. | -| [secondary](#secondary) | `secondary` | `Boolean` | false | Modifier for `type="cta"` secondary UI option. | -| [small](#small) | `small` | `Boolean` | false | Modifier for `type="cta"` small UI option. | -| [target](#target) | `target` | `String` | | Specifies where to open the linked document. | -| [type](#type) | `type` | `String` | | Enumerable attribute; [`nav`, `cta`] | +| Property | Attribute | Modifiers | Type | Default | Description | +|------------------|------------------|-----------|-----------|---------|--------------------------------------------------| +| [download](#download) | `download` | | `Boolean` | false | If true, the linked resource will be downloaded when the hyperlink is clicked. | +| [fluid](#fluid) | `fluid` | | `Boolean` | | If true and `type="cta"`, the hyperlink will have a fluid-width UI. | +| [href](#href) | `href` | | `String` | | Defines the URL of the linked page. | +| [ondark](#ondark) | `ondark` | | `Boolean` | false | If true, the hyperlink will be styled for use on a dark background. | +| [referrerpolicy](#referrerpolicy) | `referrerpolicy` | | `Boolean` | | If true, sets `strict-origin-when-cross-origin` to control the referrer information sent with requests. | +| [rel](#rel) | `rel` | | `String` | | Defines the relationship between the current document and the linked document. | +| [relative](#relative) | `relative` | | `Boolean` | false | If true, the auto URL re-write feature will be disabled. | +| [role](#role) | `role` | | `String` | | Defines ARIA roles; currently supports `button` for extended experiences. | +| [safeUri](#safeUri) | | readonly | `string` | | Returns a safe URI based on the provided `href` and `relative` parameters.
If `href` is truthy, it generates a safe URL using the `safeUrl` function.
Otherwise, it returns an empty string. | +| [secondary](#secondary) | `secondary` | | `Boolean` | false | If true and `type="cta"`, the hyperlink will have a secondary UI. | +| [small](#small) | `small` | | `Boolean` | false | If true and `type="cta"`, the hyperlink will have a small UI. | +| [target](#target) | `target` | | `String` | | Defines where to open the linked document. | +| [tertiary](#tertiary) | `tertiary` | | `Boolean` | false | If true and `type="cta"`, the hyperlink will have a tertiary UI. | +| [type](#type) | `type` | | `String` | | Defines the type of hyperlink; accepts `nav` or `cta`. | ## CSS Shadow Parts -| Part | Description | -|--------|------------------------------| -| [link](#link) | Apply CSS to the `a` element | +| Part | Description | +|--------|--------------------------------------------------| +| [link](#link) | Allows styling to be applied to the `a` element. | # auro-sidenavsection diff --git a/docs/api.md b/docs/api.md index 83b2388..1d45ed2 100644 --- a/docs/api.md +++ b/docs/api.md @@ -21,26 +21,28 @@ side of a page to navigate to seperate pages or different sections within the sa ## Properties -| Property | Attribute | Type | Default | Description | -|------------------|------------------|-----------|---------|--------------------------------------------------| -| `download` | `download` | `Boolean` | false | Specifies that the target will be downloaded when a user clicks on the hyperlink. | -| `fluid` | `fluid` | `Boolean` | | Modifier for `type="cta"` fluid-width UI option. | -| `href` | `href` | `String` | | Specifies the URL of the page link. | -| `ondark` | `ondark` | `Boolean` | false | Specifies dark theme use of hyperlink. | -| `referrerpolicy` | `referrerpolicy` | `Boolean` | | Sets `strict-origin-when-cross-origin` to send a full URL when performing a same-origin request, only sends the origin when the protocol security level stays the same (HTTPS→HTTPS), and sends no header to a less secure destination (HTTPS→HTTP). | -| `rel` | `rel` | `String` | | Specifies the relationship between the current document and the linked document. | -| `relative` | `relative` | `Boolean` | false | Add flag to disable auto URL re-write feature. | -| `role` | `role` | `String` | | Use for aria roles; currently supports `button` for extended experiences. | -| `secondary` | `secondary` | `Boolean` | false | Modifier for `type="cta"` secondary UI option. | -| `small` | `small` | `Boolean` | false | Modifier for `type="cta"` small UI option. | -| `target` | `target` | `String` | | Specifies where to open the linked document. | -| `type` | `type` | `String` | | Enumerable attribute; [`nav`, `cta`] | +| Property | Attribute | Modifiers | Type | Default | Description | +|------------------|------------------|-----------|-----------|---------|--------------------------------------------------| +| `download` | `download` | | `Boolean` | false | If true, the linked resource will be downloaded when the hyperlink is clicked. | +| `fluid` | `fluid` | | `Boolean` | | If true and `type="cta"`, the hyperlink will have a fluid-width UI. | +| `href` | `href` | | `String` | | Defines the URL of the linked page. | +| `ondark` | `ondark` | | `Boolean` | false | If true, the hyperlink will be styled for use on a dark background. | +| `referrerpolicy` | `referrerpolicy` | | `Boolean` | | If true, sets `strict-origin-when-cross-origin` to control the referrer information sent with requests. | +| `rel` | `rel` | | `String` | | Defines the relationship between the current document and the linked document. | +| `relative` | `relative` | | `Boolean` | false | If true, the auto URL re-write feature will be disabled. | +| `role` | `role` | | `String` | | Defines ARIA roles; currently supports `button` for extended experiences. | +| `safeUri` | | readonly | `string` | | Returns a safe URI based on the provided `href` and `relative` parameters.
If `href` is truthy, it generates a safe URL using the `safeUrl` function.
Otherwise, it returns an empty string. | +| `secondary` | `secondary` | | `Boolean` | false | If true and `type="cta"`, the hyperlink will have a secondary UI. | +| `small` | `small` | | `Boolean` | false | If true and `type="cta"`, the hyperlink will have a small UI. | +| `target` | `target` | | `String` | | Defines where to open the linked document. | +| `tertiary` | `tertiary` | | `Boolean` | false | If true and `type="cta"`, the hyperlink will have a tertiary UI. | +| `type` | `type` | | `String` | | Defines the type of hyperlink; accepts `nav` or `cta`. | ## CSS Shadow Parts -| Part | Description | -|--------|------------------------------| -| `link` | Apply CSS to the `a` element | +| Part | Description | +|--------|--------------------------------------------------| +| `link` | Allows styling to be applied to the `a` element. | # auro-sidenavsection