@aurodesignsystem-dev/auro-nav 0.0.0-pr86.0 → 0.0.0-pr86.1
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 +3732 -0
- package/demo/api.md +79 -58
- package/demo/auro-nav.min.js +279 -2608
- package/dist/auro-nav-CKl99nm7.js +220 -0
- package/dist/index.d.ts +61 -40
- package/dist/index.js +1 -1
- package/dist/registered.js +1 -1
- package/package.json +12 -8
- package/dist/auro-nav-D1rsnC7w.js +0 -199
package/demo/api.md
CHANGED
|
@@ -3,79 +3,100 @@
|
|
|
3
3
|
|
|
4
4
|
# auro-anchorlink
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
### Properties & Attributes
|
|
7
7
|
|
|
8
|
-
|
|
|
9
|
-
|
|
10
|
-
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|----------------------------|--------------------|
|
|
28
|
-
| `auroAnchorLink-activated` | `CustomEvent<any>` |
|
|
8
|
+
| Properties | Attributes | Type | Default | Description |
|
|
9
|
+
| --- | --- | --- | --- | --- |
|
|
10
|
+
active | active | boolean | | If set, the link is currently the active link in the parent auro-nav.
|
|
11
|
+
role | | String | | Defines ARIA roles; currently supports `button` for extended experiences.
|
|
12
|
+
safeUri | | | | Returns a safe URI based on the provided `href` and `relative` parameters.<br>If `href` is truthy, it generates a safe URL using the `safeUrl` function.<br>Otherwise, it returns an empty string.
|
|
13
|
+
includesDomain | | | | Checks whether the provided URI (if available) includes the 'http' protocol.<br>If the URI is truthy, it examines whether it contains 'http'.<br>Otherwise, it returns false.
|
|
14
|
+
appearance | appearance | string | 'default' | Defines whether the component will be on lighter or darker backgrounds.
|
|
15
|
+
download | download | boolean | false | If true, the linked resource will be downloaded when the hyperlink is clicked.
|
|
16
|
+
relative | relative | boolean | false | If true, the auto URL re-write feature will be disabled.
|
|
17
|
+
ondark | ondark | boolean | false | DEPRECATED - use `appearance` instead.
|
|
18
|
+
variant | variant | string | "primary" | Sets button variant option.
|
|
19
|
+
href | href | string | | Defines the URL of the linked page.
|
|
20
|
+
rel | rel | string | | Defines the relationship between the current document and the linked document.
|
|
21
|
+
target | target | string | | Defines where to open the linked document.
|
|
22
|
+
type | type | string | | Defines the type of hyperlink; accepts `nav` or `cta`.
|
|
23
|
+
fluid | fluid | boolean | | If true and `type="cta"`, the hyperlink will have a fluid-width UI.
|
|
24
|
+
referrerpolicy | referrerpolicy | boolean | | If true, sets `strict-origin-when-cross-origin` to control the referrer information sent with requests.
|
|
25
|
+
|
|
26
|
+
### Methods
|
|
29
27
|
|
|
30
|
-
|
|
28
|
+
| Name | Parameters | Return | Description |
|
|
29
|
+
| --- | --- | --- | --- |
|
|
30
|
+
register | `name` (string) - The name of element that you want to register to. | | This will register this element with the browser.
|
|
31
|
+
|
|
32
|
+
### CSS Shadow Parts
|
|
31
33
|
|
|
32
|
-
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
34
|
+
| Name | Description |
|
|
35
|
+
| --- | --- |
|
|
36
|
+
link | Allows styling to be applied to the `a` element.
|
|
37
|
+
targetIcon | Allows styling to be applied to the icon that appears next to the hyperlink.
|
|
38
|
+
|
|
39
|
+
---
|
|
36
40
|
|
|
37
41
|
# auro-breadcrumb
|
|
38
42
|
|
|
39
|
-
|
|
43
|
+
### Properties & Attributes
|
|
40
44
|
|
|
41
|
-
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
45
|
+
| Properties | Attributes | Type | Default | Description |
|
|
46
|
+
| --- | --- | --- | --- | --- |
|
|
47
|
+
role | | String | | Defines ARIA roles; currently supports `button` for extended experiences.
|
|
48
|
+
safeUri | | | | Returns a safe URI based on the provided `href` and `relative` parameters.<br>If `href` is truthy, it generates a safe URL using the `safeUrl` function.<br>Otherwise, it returns an empty string.
|
|
49
|
+
includesDomain | | | | Checks whether the provided URI (if available) includes the 'http' protocol.<br>If the URI is truthy, it examines whether it contains 'http'.<br>Otherwise, it returns false.
|
|
50
|
+
appearance | appearance | string | 'default' | Defines whether the component will be on lighter or darker backgrounds.
|
|
51
|
+
download | download | boolean | false | If true, the linked resource will be downloaded when the hyperlink is clicked.
|
|
52
|
+
relative | relative | boolean | false | If true, the auto URL re-write feature will be disabled.
|
|
53
|
+
ondark | ondark | boolean | false | DEPRECATED - use `appearance` instead.
|
|
54
|
+
variant | variant | string | "primary" | Sets button variant option.
|
|
55
|
+
href | href | string | | Defines the URL of the linked page.
|
|
56
|
+
rel | rel | string | | Defines the relationship between the current document and the linked document.
|
|
57
|
+
target | target | string | | Defines where to open the linked document.
|
|
58
|
+
type | type | string | | Defines the type of hyperlink; accepts `nav` or `cta`.
|
|
59
|
+
fluid | fluid | boolean | | If true and `type="cta"`, the hyperlink will have a fluid-width UI.
|
|
60
|
+
referrerpolicy | referrerpolicy | boolean | | If true, sets `strict-origin-when-cross-origin` to control the referrer information sent with requests.
|
|
61
|
+
|
|
62
|
+
### Methods
|
|
55
63
|
|
|
56
|
-
|
|
64
|
+
| Name | Parameters | Return | Description |
|
|
65
|
+
| --- | --- | --- | --- |
|
|
66
|
+
register | `name` (string) - The name of element that you want to register to. | | This will register this element with the browser.
|
|
67
|
+
|
|
68
|
+
### CSS Shadow Parts
|
|
57
69
|
|
|
58
|
-
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
70
|
+
| Name | Description |
|
|
71
|
+
| --- | --- |
|
|
72
|
+
link | Allows styling to be applied to the `a` element.
|
|
73
|
+
targetIcon | Allows styling to be applied to the icon that appears next to the hyperlink.
|
|
74
|
+
|
|
75
|
+
---
|
|
62
76
|
|
|
63
77
|
# auro-nav
|
|
64
78
|
|
|
65
|
-
|
|
79
|
+
### Properties & Attributes
|
|
66
80
|
|
|
67
|
-
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
|
81
|
+
| Properties | Attributes | Type | Default | Description |
|
|
82
|
+
| --- | --- | --- | --- | --- |
|
|
83
|
+
anchorNavContent | anchorNavContent | string | undefined | Defines the container that anchor links navigate within.
|
|
84
|
+
activeLink | activeLink | object | undefined | If set, defines the currently active link.
|
|
85
|
+
noHomeIcon | noHomeIcon | boolean | | If true, the home icon will not be displayed before first auro-breadcrumb.
|
|
86
|
+
|
|
87
|
+
### Methods
|
|
71
88
|
|
|
72
|
-
|
|
89
|
+
| Name | Parameters | Return | Description |
|
|
90
|
+
| --- | --- | --- | --- |
|
|
91
|
+
register | `name` (string) - The name of element that you want to register to. | | This will register this element with the browser.
|
|
92
|
+
|
|
93
|
+
### Slots
|
|
73
94
|
|
|
74
|
-
| Name
|
|
75
|
-
|
|
76
|
-
|
|
|
77
|
-
|
|
78
|
-
|
|
95
|
+
| Name | Description |
|
|
96
|
+
| --- | --- |
|
|
97
|
+
Slot | for insertion of navigation links.
|
|
98
|
+
mobileToggleExpanded | Slot for button text in mobile when content is expanded.
|
|
99
|
+
mobileToggleCollapsed | Slot for button text in mobile when content is collapsed.
|
|
79
100
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
80
101
|
|
|
81
102
|
## API Examples
|