@quartzds/core 1.0.0-beta.12 → 1.0.0-beta.120

package/dist/types/components/breadcrumb-item/breadcrumb-item.d.ts

@@ -0,0 +1,178 @@
+import type { ComponentInterface } from '../../stencil-public-runtime';
+import type { LiteralUnion } from 'type-fest';
+export type BreadcrumbTarget = '_blank' | '_parent' | '_self' | '_top';
+/**
+ * The `<qds-breadcrumb-item>` element is used as a navigational aid that is
+ * typically placed between a site's header and the main content, displaying
+ * either a hierarchy of the current page in relation to the site's structure,
+ * from top level to current page, or a list of the links the user followed to
+ * get to the current page, in the order visited.
+ *
+ * @see https://quartz.se.com/build/components/breadcrumb
+ */
+export declare class QdsBreadcrumbItem implements ComponentInterface {
+    #private;
+    /**
+     * The breadcrumb item's text.
+     */
+    readonly text: string;
+    /**
+     * Prevents the breadcrumb item from being interacted with: it cannot be pressed
+     * or focused.
+     */
+    readonly disabled: boolean;
+    /**
+     * The name of the icon to render.
+     *
+     * Available names depend on the icon library being used.
+     */
+    readonly iconName?: string;
+    /**
+     * The name of a registered icon library.
+     */
+    readonly iconLibrary: string;
+    /**
+     * The URL that the inline link points to. Inline links are not restricted to
+     * HTTP-based URLs — they can use any URL scheme supported by browsers:
+     *
+     * - Sections of a page with document fragments
+     * - While web browsers may not support other URL schemes, websites can with
+     * [`registerProtocolHandler()`](https://developer.mozilla.org/docs/Web/API/Navigator/registerProtocolHandler)
+     *
+     * @webnative
+     */
+    readonly href?: string;
+    /**
+     * Hints at the human language of the linked URL. No built-in functionality.
+     * Allowed values are the same as
+     * [the global `lang` attribute](https://developer.mozilla.org/docs/Web/HTML/Global_attributes/lang).
+     *
+     * @webnative
+     */
+    readonly hreflang?: string;
+    /**
+     * How much of the
+     * [referrer](https://developer.mozilla.org/docs/Web/HTTP/Headers/Referer)
+     * to send when following the inline link.
+     *
+     * - `no-referrer`: The
+     * [`Referer`](https://developer.mozilla.org/docs/Web/HTTP/Headers/Referer)
+     * header will not be sent.
+     * - `no-referrer-when-downgrade`: The
+     * [`Referer`](https://developer.mozilla.org/docs/Web/HTTP/Headers/Referer)
+     * header will not be sent to
+     * [origin](https://developer.mozilla.org/docs/Glossary/Origin)s
+     * without [TLS](https://developer.mozilla.org/docs/Glossary/TLS)
+     * ([HTTPS](https://developer.mozilla.org/docs/Glossary/HTTPS)).
+     * - `origin`: The sent referrer will be limited to the origin of the
+     * referring page: its
+     * [scheme](https://developer.mozilla.org/docs/Learn/Common_questions/What_is_a_URL),
+     * [host](https://developer.mozilla.org/docs/Glossary/Host), and
+     * [port](https://developer.mozilla.org/docs/Glossary/Port).
+     * - `origin-when-cross-origin`: The referrer sent to other origins will be
+     * limited to the scheme, the host, and the port. Navigations on the same
+     * origin will still include the path.
+     * - `same-origin`: A referrer will be sent for
+     * [same origin](https://developer.mozilla.org/docs/Glossary/Same-origin_policy),
+     * but cross-origin requests will contain no referrer information.
+     * - `strict-origin`: Only send the origin of the document as the referrer
+     * when the protocol security level stays the same (HTTPS→HTTPS), but don't
+     * send it to a less secure destination (HTTPS→HTTP).
+     * - `strict-origin-when-cross-origin` (default): Send a full URL when
+     * performing a same-origin request, only send the origin when the protocol
+     * security level stays the same (HTTPS→HTTPS), and send no header to a less
+     * secure destination (HTTPS→HTTP).
+     * - `unsafe-url`: The referrer will include the origin and the path (but not the
+     * [fragment](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/hash),
+     * [password](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/password),
+     * or [username](https://developer.mozilla.org/docs/Web/API/HTMLAnchorElement/username)).
+     * **This value is unsafe** because it leaks origins and paths from
+     * TLS-protected resources to insecure origins.
+     *
+     * @webnative
+     */
+    readonly referrerPolicy?: ReferrerPolicy;
+    /**
+     * The relationship of the linked URL as space-separated
+     * [link types](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel).
+     *
+     * The following list includes some of the most important existing keywords.
+     * Every keyword within a space-separated value should be unique within that
+     * value.
+     *
+     * - [`alternate`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-alternate):
+     * Alternate representations of the current document.
+     * - [`author`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-author):
+     * Author of the current document or article.
+     * - [`bookmark`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-bookmark):
+     * Permalink for the nearest ancestor section.
+     * - [`external`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-external):
+     * The referenced document is not part of the same site as the current
+     * document. An icon will be rendered next to the text if this value is
+     * specified.
+     * - [`help`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-help):
+     * Link to context-sensitive help.
+     * - [`license`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-license):
+     * Indicates that the main content of the current document is covered by the
+     * copyright license described by the referenced document.
+     * - [`me`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel/me):
+     * Indicates that the current document represents the person who owns the
+     * linked content.
+     * - [`next`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-next):
+     * Indicates that the current document is a part of a series and that the
+     * next document in the series is the referenced document.
+     * - [`nofollow`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-nofollow):
+     * Indicates that the current document's original author or publisher does
+     * not endorse the referenced document.
+     * - [`noopener`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel/noopener):
+     * Creates a top-level browsing context that is not an auxiliary browsing
+     * context if the hyperlink would create either of those, to begin with (i.e.,
+     * has an appropriate `target` attribute value).
+     * - [`noreferrer`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-noreferrer):
+     * No `Referer` header will be included. Additionally, has the same effect as
+     * `noopener`.
+     * - [`opener`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-opener):
+     * Creates an auxiliary browsing context if the hyperlink would otherwise
+     * create a top-level browsing context that is not an auxiliary browsing
+     * context (i.e., has "`_blank`" as `target` attribute value).
+     * - [`prev`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-prev):
+     * Indicates that the current document is a part of a series and that the
+     * previous document in the series is the referenced document.
+     * - [`search`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-search):
+     * Gives a link to a resource that can be used to search through the current
+     * document and its related pages.
+     * - [`tag`](https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-tag):
+     * Gives a tag (identified by the given address) that applies to the current
+     * document.
+     *
+     * @webnative
+     */
+    readonly rel?: string;
+    /**
+     * Where to display the linked URL, as the name for a browsing context (a
+     * tab, window, or
+     * [`<iframe>`](https://developer.mozilla.org/docs/Web/HTML/Element/iframe).
+     * The following keywords have special meanings for where to load the URL:
+     *
+     * - `_blank`: usually a new tab, but users can configure browsers to open a new
+     *   window instead.
+     * - `_parent`: the parent browsing context of the current one. If no parent,
+     *   behaves as `_self`.
+     * - `_self`: the current browsing context.
+     * - `_top`: the topmost browsing context (the "highest" context that's an
+     *   ancestor of the current one). If no ancestors, behaves as `_self`.
+     *
+     * @webnative
+     */
+    readonly target?: LiteralUnion<BreadcrumbTarget, string>;
+    private tooltip;
+    private readonly internals;
+    protected onClick(event: MouseEvent): void;
+    protected disabledChanged(): void;
+    protected textChanged(): void;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    disconnectedCallback(): void;
+    render(): any;
+}
+//# sourceMappingURL=breadcrumb-item.d.ts.map