@aurodesignsystem-dev/auro-nav 0.0.0-pr110.0 → 0.0.0-pr110.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements.json +162 -328
- package/demo/api.md +8 -32
- package/demo/auro-nav.min.js +17 -11
- package/dist/{auro-nav-8gtpUxpu.js → auro-nav-D0mx74fk.js} +6 -6
- package/dist/index.d.ts +15 -15
- package/dist/index.js +1 -1
- package/dist/registered.js +1 -1
- package/package.json +6 -7
package/demo/api.md
CHANGED
|
@@ -7,22 +7,10 @@ The `auro-anchorlink` element is used to create anchor navigation links within a
|
|
|
7
7
|
|
|
8
8
|
### Properties & Attributes
|
|
9
9
|
|
|
10
|
-
| Properties
|
|
11
|
-
|
|
|
12
|
-
| active
|
|
13
|
-
|
|
|
14
|
-
| download | download | | boolean | | If true, the linked resource will be downloaded when the hyperlink is clicked. |
|
|
15
|
-
| fluid | fluid | | boolean | | If true and `type="cta"`, the hyperlink will have a fluid-width UI. |
|
|
16
|
-
| href | href | | string | | Defines the URL of the linked page. |
|
|
17
|
-
| layout | layout | | string | `{'default'}` | Defines the language of an element. |
|
|
18
|
-
| ondark | ondark | | boolean | | DEPRECATED - use `appearance="inverse"` instead. |
|
|
19
|
-
| referrerpolicy | referrerpolicy | | boolean | | If true, sets `strict-origin-when-cross-origin` to control the referrer information sent with requests. |
|
|
20
|
-
| rel | rel | | string | | Defines the relationship between the current document and the linked document. Visit [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/rel) for more information. |
|
|
21
|
-
| role | | | string | | Defines ARIA roles; currently supports `button` for extended experiences. |
|
|
22
|
-
| safeUri | | readonly | string | | Returns a safe URI based on the provided `href`.<br>If `href` is truthy, it generates a safe URL using the `safeUrl` function.<br>Otherwise, it returns an empty string. |
|
|
23
|
-
| target | target | | string | | Defines where to open the linked document. |
|
|
24
|
-
| type | type | | `nav` \| `cta` | | Defines the type of hyperlink. |
|
|
25
|
-
| variant | variant | | `primary` \| `secondary` \| `tertiary` \| `ghost` \| `flat` | `primary` | Sets button variant option when using `type="cta"`. |
|
|
10
|
+
| Properties | Attributes | Modifiers | Type | Default | Description |
|
|
11
|
+
| ---------- | ---------- | --------- | ------- | ------- | ----------------------------------------------------------------------- |
|
|
12
|
+
| active | active | | boolean | | If set, the link is currently the active link in the parent `auro-nav`. |
|
|
13
|
+
| href | href | | string | | Defines the URL of the linked page. |
|
|
26
14
|
|
|
27
15
|
### Methods
|
|
28
16
|
|
|
@@ -43,21 +31,9 @@ The `auro-breadcrumb` element is a horizontal navigation component that indicate
|
|
|
43
31
|
|
|
44
32
|
### Properties & Attributes
|
|
45
33
|
|
|
46
|
-
| Properties
|
|
47
|
-
|
|
|
48
|
-
|
|
|
49
|
-
| download | download | | boolean | | If true, the linked resource will be downloaded when the hyperlink is clicked. |
|
|
50
|
-
| fluid | fluid | | boolean | | If true and `type="cta"`, the hyperlink will have a fluid-width UI. |
|
|
51
|
-
| href | href | | string | | Defines the URL of the linked page. |
|
|
52
|
-
| layout | layout | | string | `{'default'}` | Defines the language of an element. |
|
|
53
|
-
| ondark | ondark | | boolean | | DEPRECATED - use `appearance="inverse"` instead. |
|
|
54
|
-
| referrerpolicy | referrerpolicy | | boolean | | If true, sets `strict-origin-when-cross-origin` to control the referrer information sent with requests. |
|
|
55
|
-
| rel | rel | | string | | Defines the relationship between the current document and the linked document. Visit [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/rel) for more information. |
|
|
56
|
-
| role | | | string | | Defines ARIA roles; currently supports `button` for extended experiences. |
|
|
57
|
-
| safeUri | | readonly | string | | Returns a safe URI based on the provided `href`.<br>If `href` is truthy, it generates a safe URL using the `safeUrl` function.<br>Otherwise, it returns an empty string. |
|
|
58
|
-
| target | target | | string | | Defines where to open the linked document. |
|
|
59
|
-
| type | type | | `nav` \| `cta` | | Defines the type of hyperlink. |
|
|
60
|
-
| variant | variant | | `primary` \| `secondary` \| `tertiary` \| `ghost` \| `flat` | `primary` | Sets button variant option when using `type="cta"`. |
|
|
34
|
+
| Properties | Attributes | Modifiers | Type | Default | Description |
|
|
35
|
+
| ---------- | ---------- | --------- | ------ | ------- | ----------------------------------- |
|
|
36
|
+
| href | href | | string | | Defines the URL of the linked page. |
|
|
61
37
|
|
|
62
38
|
### Methods
|
|
63
39
|
|
|
@@ -74,7 +50,7 @@ The `auro-breadcrumb` element is a horizontal navigation component that indicate
|
|
|
74
50
|
|
|
75
51
|
# auro-nav
|
|
76
52
|
|
|
77
|
-
The auro-nav element provides a way to show users a secondary navigation aid that helps them understand the relation between the location of their current page and higher level pages.
|
|
53
|
+
The `auro-nav` element provides a way to show users a secondary navigation aid that helps them understand the relation between the location of their current page and higher level pages.
|
|
78
54
|
|
|
79
55
|
### Properties & Attributes
|
|
80
56
|
|