@aurodesignsystem/auro-nav

{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/auro-anchorlink.js", "declarations": [ { "kind": "class", "description": "The `auro-anchorlink` element is used to create anchor navigation links within a page, typically used inside an `auro-nav` component.", "name": "AuroAnchorlink", "members": [ { "kind": "method", "name": "_createRefs", "description": "Create usable refs to internal elements", "return": { "type": { "text": "void" } }, "privacy": "private", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "method", "name": "_initializeDefaults", "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" }, "type": { "text": "_initializeDefaults() => void" } }, { "kind": "field", "name": "active", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, the link is currently the active link in the parent `auro-nav`.", "attribute": "active", "reflects": true }, { "kind": "field", "name": "appearance", "privacy": "private", "type": { "text": "string" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "attribute": "appearance", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "method", "name": "ariaPressedState", "parameters": [ { "name": "ariaPressed", "description": "The initial value of the ARIA pressed state.", "type": { "text": "boolean" } } ], "description": "Sets the ARIA pressed state based on user interactions.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "attributeWatcher", "description": "return object from transportAttributes via a11yUtilities", "type": { "text": "Object" }, "privacy": "private", "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "field", "name": "download", "privacy": "private", "type": { "text": "boolean" }, "description": "If true, the linked resource will be downloaded when the hyperlink is clicked.", "attribute": "download", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "fluid", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the anchorlink will have a fluid-width UI.", "attribute": "fluid", "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" }, "default": "true" }, { "kind": "method", "name": "generateIconHtml", "parameters": [ { "name": "svgContent", "description": "The SVG content to be embedded.", "type": { "text": "string" } } ], "description": "Generates an HTML element containing an SVG icon based on the provided `svgContent`.", "privacy": "private", "return": { "type": { "text": "Element" } }, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "getMarkup", "description": "Generates an object containing CSS classes based on the properties of the component.", "privacy": "private", "return": { "type": { "text": "object" } }, "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "method", "name": "getRelType", "parameters": [ { "name": "target", "description": "The target attribute of the anchor element.", "type": { "text": "string" } }, { "name": "rel", "description": "The rel attribute of the anchor element.", "type": { "text": "string" } } ], "description": "Gets the rel attribute value based on target and rel values.", "privacy": "private", "return": { "type": { "text": "string|undefined" } }, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "getTabState", "parameters": [ { "name": "tabIsActive", "description": "Indicates whether the tab is active.", "type": { "text": "boolean" } } ], "description": "Returns the state of a tab as a string.", "privacy": "private", "return": { "type": { "text": "string" } }, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "href", "privacy": "public", "type": { "text": "string" }, "description": "Defines the URL of the linked page.", "attribute": "href", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "iconTag", "privacy": "private", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "field", "name": "includesDomain", "description": "Checks whether the provided URI (if available) includes the 'http' protocol.\nIf the URI is truthy, it examines whether it contains 'http'.\nOtherwise, it returns false.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "readonly": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "layout", "privacy": "private", "type": { "text": "string" }, "description": "Defines the language of an element.", "default": "'default'", "attribute": "layout", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "field", "name": "ondark", "privacy": "private", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "attribute": "ondark", "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "onDark", "privacy": "private", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance` attribute.", "default": "false", "attribute": "ondark", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "field", "name": "referrerpolicy", "privacy": "private", "type": { "text": "boolean" }, "description": "If true, sets `strict-origin-when-cross-origin` to control the referrer information sent with requests.", "attribute": "referrerpolicy", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-anchorlink\"", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser.", "type": { "text": "register(name?: string = \"auro-anchorlink\") => void" }, "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "field", "name": "rel", "privacy": "private", "type": { "text": "string" }, "description": "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.", "attribute": "rel", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "renderLayoutCTA", "description": "Renders the cta layout for the hyperlink.", "return": { "type": { "text": "TemplateResult" } }, "privacy": "private", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "method", "name": "renderLayoutDefault", "description": "Renders the default layout for the hyperlink.", "return": { "type": { "text": "TemplateResult" } }, "privacy": "private", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "method", "name": "resetLayoutClasses", "privacy": "private", "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "method", "name": "resetShapeClasses", "privacy": "private", "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "type": { "text": "string" }, "description": "Defines ARIA roles; currently supports `button` for extended experiences.", "name": "role", "kind": "field", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" }, "privacy": "private" }, { "kind": "field", "name": "safeUri", "description": "Returns a safe URI based on the provided `href`.\nIf `href` is truthy, it generates a safe URL using the `safeUrl` function.\nOtherwise, it returns an empty string.", "return": { "type": { "text": "string" } }, "readonly": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" }, "privacy": "private" }, { "kind": "method", "name": "safeUrl", "parameters": [ { "name": "href", "description": "The original URL.", "type": { "text": "string" } } ], "description": "Generates a safe URL based on the provided `href` parameter.\nIf `href` is falsy, it returns `undefined`.", "privacy": "private", "return": { "type": { "text": "string|undefined" } }, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "shadowRootOptions", "static": true, "readonly": true, "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "field", "name": "shape", "privacy": "private", "type": { "text": "string" }, "description": "Defines the shape of an element.", "default": "{'default'}", "attribute": "shape", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "field", "name": "size", "privacy": "private", "type": { "text": "string" }, "description": "Defines the size of an element.", "default": "{'md'}", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "field", "name": "target", "privacy": "private", "type": { "text": "string" }, "description": "Defines where to open the linked document.", "attribute": "target", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "targetIcon", "parameters": [ { "name": "target", "description": "The target attribute of the anchor element.", "type": { "text": "string" } } ], "description": "Generates an icon HTML element based on the target attribute.", "privacy": "private", "return": { "type": { "text": "HTMLElement|undefined" } }, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "type", "privacy": "private", "type": { "text": "'nav' | 'cta'" }, "description": "Defines the type of hyperlink.", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "updateComponentArchitecture", "privacy": "private", "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "field", "name": "variant", "privacy": "private", "type": { "text": "'primary' | 'secondary' | 'tertiary' | 'ghost' | 'flat'" }, "description": "Sets button variant option when using `type=\"cta\"`.", "default": "'primary'", "attribute": "variant", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "wrapper", "privacy": "private", "description": "A reference to the wrapper element in the shadow DOM.\nThis is used to apply layout and shape classes dynamically.", "type": { "text": "HTMLElement|null" }, "default": "{null}", "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } } ], "events": [ { "name": "auroAnchorLink-activated", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "active", "type": { "text": "boolean" }, "description": "If set, the link is currently the active link in the parent `auro-nav`.", "fieldName": "active" }, { "name": "fluid", "type": { "text": "boolean" }, "description": "If true, the anchorlink will have a fluid-width UI.", "fieldName": "fluid", "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" }, "default": "true" }, { "name": "href", "type": { "text": "string" }, "description": "Defines the URL of the linked page.", "fieldName": "href", "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } } ], "superclass": { "name": "AuroHyperlink", "package": "@aurodesignsystem/auro-hyperlink/class" }, "tagName": "auro-anchorlink", "customElement": true, "cssParts": [ { "description": "Allows styling to be applied to the `a` element.", "name": "link", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "description": "Allows styling to be applied to the icon that appears next to the hyperlink.", "name": "targetIcon", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } } ], "modulePath": "src/auro-anchorlink.js" } ], "exports": [ { "kind": "js", "name": "AuroAnchorlink", "declaration": { "name": "AuroAnchorlink", "module": "src/auro-anchorlink.js" } } ] }, { "kind": "javascript-module", "path": "src/auro-breadcrumb.js", "declarations": [ { "kind": "class", "description": "The `auro-breadcrumb` element is a horizontal navigation component that indicates the current page's location within a navigational hierarchy, typically used within an `auro-nav` component.", "name": "AuroBreadcrumb", "members": [ { "kind": "method", "name": "_createRefs", "description": "Create usable refs to internal elements", "return": { "type": { "text": "void" } }, "privacy": "private", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "method", "name": "_initializeDefaults", "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" }, "type": { "text": "_initializeDefaults() => void" } }, { "kind": "field", "name": "appearance", "privacy": "private", "type": { "text": "string" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "attribute": "appearance", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "method", "name": "ariaPressedState", "parameters": [ { "name": "ariaPressed", "description": "The initial value of the ARIA pressed state.", "type": { "text": "boolean" } } ], "description": "Sets the ARIA pressed state based on user interactions.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "attributeWatcher", "description": "return object from transportAttributes via a11yUtilities", "type": { "text": "Object" }, "privacy": "private", "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "field", "name": "download", "privacy": "private", "type": { "text": "boolean" }, "description": "If true, the linked resource will be downloaded when the hyperlink is clicked.", "attribute": "download", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "fluid", "privacy": "private", "type": { "text": "boolean" }, "description": "If true and `type=\"cta\"`, the hyperlink will have a fluid-width UI.", "attribute": "fluid", "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "generateIconHtml", "parameters": [ { "name": "svgContent", "description": "The SVG content to be embedded.", "type": { "text": "string" } } ], "description": "Generates an HTML element containing an SVG icon based on the provided `svgContent`.", "privacy": "private", "return": { "type": { "text": "Element" } }, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "getMarkup", "description": "Generates an object containing CSS classes based on the properties of the component.", "privacy": "private", "return": { "type": { "text": "object" } }, "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "method", "name": "getRelType", "parameters": [ { "name": "target", "description": "The target attribute of the anchor element.", "type": { "text": "string" } }, { "name": "rel", "description": "The rel attribute of the anchor element.", "type": { "text": "string" } } ], "description": "Gets the rel attribute value based on target and rel values.", "privacy": "private", "return": { "type": { "text": "string|undefined" } }, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "getTabState", "parameters": [ { "name": "tabIsActive", "description": "Indicates whether the tab is active.", "type": { "text": "boolean" } } ], "description": "Returns the state of a tab as a string.", "privacy": "private", "return": { "type": { "text": "string" } }, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "href", "privacy": "public", "type": { "text": "string" }, "description": "Defines the URL of the linked page.", "attribute": "href", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "iconTag", "privacy": "private", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "field", "name": "includesDomain", "description": "Checks whether the provided URI (if available) includes the 'http' protocol.\nIf the URI is truthy, it examines whether it contains 'http'.\nOtherwise, it returns false.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "readonly": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "layout", "privacy": "private", "type": { "text": "string" }, "description": "Defines the language of an element.", "default": "'default'", "attribute": "layout", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "field", "name": "ondark", "privacy": "private", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "attribute": "ondark", "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "onDark", "privacy": "private", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance` attribute.", "default": "false", "attribute": "ondark", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "field", "name": "referrerpolicy", "privacy": "private", "type": { "text": "boolean" }, "description": "If true, sets `strict-origin-when-cross-origin` to control the referrer information sent with requests.", "attribute": "referrerpolicy", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-breadcrumb\"", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser.", "type": { "text": "register(name?: string = \"auro-breadcrumb\") => void" }, "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "field", "name": "rel", "privacy": "private", "type": { "text": "string" }, "description": "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.", "attribute": "rel", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "renderLayoutCTA", "description": "Renders the cta layout for the hyperlink.", "return": { "type": { "text": "TemplateResult" } }, "privacy": "private", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "method", "name": "renderLayoutDefault", "description": "Renders the default layout for the hyperlink.", "return": { "type": { "text": "TemplateResult" } }, "privacy": "private", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "method", "name": "resetLayoutClasses", "privacy": "private", "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "method", "name": "resetShapeClasses", "privacy": "private", "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "type": { "text": "string" }, "description": "Defines ARIA roles; currently supports `button` for extended experiences.", "name": "role", "kind": "field", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" }, "privacy": "private" }, { "kind": "field", "name": "safeUri", "description": "Returns a safe URI based on the provided `href`.\nIf `href` is truthy, it generates a safe URL using the `safeUrl` function.\nOtherwise, it returns an empty string.", "return": { "type": { "text": "string" } }, "readonly": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" }, "privacy": "private" }, { "kind": "method", "name": "safeUrl", "parameters": [ { "name": "href", "description": "The original URL.", "type": { "text": "string" } } ], "description": "Generates a safe URL based on the provided `href` parameter.\nIf `href` is falsy, it returns `undefined`.", "privacy": "private", "return": { "type": { "text": "string|undefined" } }, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "shadowRootOptions", "static": true, "readonly": true, "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "kind": "field", "name": "shape", "privacy": "private", "type": { "text": "string" }, "description": "Defines the shape of an element.", "default": "{'default'}", "attribute": "shape", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "field", "name": "size", "privacy": "private", "type": { "text": "string" }, "description": "Defines the size of an element.", "default": "{'md'}", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "field", "name": "target", "privacy": "private", "type": { "text": "string" }, "description": "Defines where to open the linked document.", "attribute": "target", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "targetIcon", "parameters": [ { "name": "target", "description": "The target attribute of the anchor element.", "type": { "text": "string" } } ], "description": "Generates an icon HTML element based on the target attribute.", "privacy": "private", "return": { "type": { "text": "HTMLElement|undefined" } }, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "type", "privacy": "private", "type": { "text": "'nav' | 'cta'" }, "description": "Defines the type of hyperlink.", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "method", "name": "updateComponentArchitecture", "privacy": "private", "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } }, { "kind": "field", "name": "variant", "privacy": "private", "type": { "text": "'primary' | 'secondary' | 'tertiary' | 'ghost' | 'flat'" }, "description": "Sets button variant option when using `type=\"cta\"`.", "default": "'primary'", "attribute": "variant", "reflects": true, "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } }, { "kind": "field", "name": "wrapper", "privacy": "private", "description": "A reference to the wrapper element in the shadow DOM.\nThis is used to apply layout and shape classes dynamically.", "type": { "text": "HTMLElement|null" }, "default": "{null}", "inheritedFrom": { "name": "AuroElement", "module": "src/layoutElement/auroElement.js" } } ], "superclass": { "name": "AuroHyperlink", "package": "@aurodesignsystem/auro-hyperlink/class" }, "tagName": "auro-breadcrumb", "customElement": true, "cssParts": [ { "description": "Allows styling to be applied to the `a` element.", "name": "link", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } }, { "description": "Allows styling to be applied to the icon that appears next to the hyperlink.", "name": "targetIcon", "inheritedFrom": { "name": "AuroHyperlink", "module": "src/auro-hyperlink.js" } } ], "attributes": [ { "name": "href", "type": { "text": "string" }, "description": "Defines the URL of the linked page.", "fieldName": "href", "inheritedFrom": { "name": "ComponentBase", "module": "src/component-base.mjs" } } ], "modulePath": "src/auro-breadcrumb.js" } ], "exports": [ { "kind": "js", "name": "AuroBreadcrumb", "declaration": { "name": "AuroBreadcrumb", "module": "src/auro-breadcrumb.js" } } ] }, { "kind": "javascript-module", "path": "src/auro-nav.js", "declarations": [ { "kind": "class", "description": "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.", "name": "AuroNav", "slots": [ { "description": "Slot for button text in mobile when content is collapsed.", "name": "mobileToggleCollapsed" }, { "description": "Slot for button text in mobile when content is expanded.", "name": "mobileToggleExpanded" }, { "description": "for insertion of navigation links.", "name": "Slot" } ], "members": [ { "kind": "method", "name": "_initializeDefaults", "type": { "text": "_initializeDefaults() => void" } }, { "kind": "field", "name": "activeLink", "privacy": "public", "type": { "text": "object" }, "description": "If set, defines the currently active link.", "attribute": "activeLink" }, { "kind": "field", "name": "anchorNavContent", "privacy": "public", "type": { "text": "string" }, "description": "Defines the container that anchor links navigate within.", "attribute": "anchorNavContent" }, { "kind": "method", "name": "assessActiveAnchorLink", "description": "Sets the activeLink attribute based on which linked content section is in view.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleAnchorNavAnimation", "description": "Used for the anchorLink version to animate the position and size of the marker used to identify the active link.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleLabelSlot", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleSlotItems", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "insertIcon", "parameters": [ { "name": "link", "description": "Hyperlink in which the auro-icon is inserted.", "type": { "text": "Object" } }, { "name": "category", "description": "Category that the auro-icon is classified under.", "type": { "text": "String" } }, { "name": "name", "description": "Name of the auro-icon.", "type": { "text": "String" } }, { "name": "props", "description": "Custom CSS properties for auro-icon.", "type": { "text": "String" } } ], "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "isScrolledIntoView", "parameters": [ { "name": "elem", "description": "The element to check if it is currently visible in the scrollContainer.", "type": { "text": "Object" } } ], "description": "Used with the anchorLink version to determine if the designated content is currently viewable in the scrollbox.", "privacy": "private", "return": { "type": { "text": "Boolean" } } }, { "kind": "method", "name": "manageAnchorlinks", "description": "Used for the anchorLink version to bind events to all link elements in the slotted content.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "manageBreadcrumbs", "privacy": "private", "return": { "type": {