@openreachtech/furo-vue 1.3.1

package/types/generated/components/molecules/FuroSectionHeader/FuroSectionHeader.vue.d.ts

@@ -0,0 +1,49 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<{
+    parcel: import("./FuroSectionHeaderContext.js").FuroSectionHeaderParcel | null;
+}, {
+    context: FuroSectionHeaderContext;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
+    parcel: import("./FuroSectionHeaderContext.js").FuroSectionHeaderParcel | null;
+}> & Readonly<{}>, {
+    parcel: import("./FuroSectionHeaderContext.js").FuroSectionHeaderParcel;
+}, {}, {
+    FuroSeparator: import("vue").DefineComponent<{
+        parcel: {
+            orientation?: "horizontal" | "vertical";
+            decorative?: boolean;
+        } | null;
+    }, {
+        context: import("../FuroSeparator/FuroSeparatorContext.js").default;
+    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
+        parcel: {
+            orientation?: "horizontal" | "vertical";
+            decorative?: boolean;
+        } | null;
+    }> & Readonly<{}>, {
+        parcel: {
+            orientation?: "horizontal" | "vertical";
+            decorative?: boolean;
+        };
+    }, {}, {
+        RekaSeparator: {
+            new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").SeparatorProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {}, false, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
+                P: {};
+                B: {};
+                D: {};
+                C: {};
+                M: {};
+                Defaults: {};
+            }, Readonly<import("reka-ui").SeparatorProps> & Readonly<{}>, {}, {}, {}, {}, {}>;
+            __isFragment?: never;
+            __isTeleport?: never;
+            __isSuspense?: never;
+        } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").SeparatorProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+            $slots: {
+                default?: (props: {}) => any;
+            };
+        });
+    }, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+import FuroSectionHeaderContext from './FuroSectionHeaderContext.js';

package/types/generated/components/molecules/FuroSectionHeader/FuroSectionHeaderContext.d.ts

@@ -0,0 +1,121 @@
+/**
+ * Context class for FuroSectionHeader molecule.
+ *
+ * @extends {BaseFuroContext<null, Props, null>}
+ */
+export default class FuroSectionHeaderContext extends BaseFuroContext<null, Props, null> {
+    /**
+     * Sizes the header can take.
+     *
+     * @returns {Array<FuroSectionHeaderSize>} Sizes, largest first.
+     */
+    static get SIZES(): Array<FuroSectionHeaderSize>;
+    /**
+     * Default size.
+     *
+     * @returns {FuroSectionHeaderSize} Size used when the parcel names none.
+     */
+    static get DEFAULT_SIZE(): FuroSectionHeaderSize;
+    /**
+     * Default heading level.
+     *
+     * @returns {number} Heading level used when the parcel names none.
+     */
+    static get DEFAULT_HEADING_LEVEL(): number;
+    /**
+     * Shallowest heading level HTML defines.
+     *
+     * @returns {number} Shallowest level.
+     */
+    static get SHALLOWEST_HEADING_LEVEL(): number;
+    /**
+     * Deepest heading level HTML defines.
+     *
+     * @returns {number} Deepest level.
+     */
+    static get DEEPEST_HEADING_LEVEL(): number;
+    constructor({ props, componentContext, reactiveHash, refHash, shallowRefHash, modelRefHash, }: import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams<Props, null, {}, {}, {}, {}>);
+    /**
+     * get: Constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroSectionHeaderContext} Constructor.
+     */
+    override get Ctor(): typeof FuroSectionHeaderContext;
+    /**
+     * get: text the heading renders.
+     *
+     * @returns {string} Title; empty string when unset.
+     */
+    get title(): string;
+    /**
+     * get: type step the title renders at.
+     *
+     * @returns {FuroSectionHeaderSize} Size.
+     */
+    get size(): FuroSectionHeaderSize;
+    /**
+     * get: depth of the heading in the consumer's document outline.
+     *
+     * Clamped to the levels HTML defines, because `h0` and `h7` are not elements.
+     *
+     * @returns {number} Heading level.
+     */
+    get headingLevel(): number;
+    /**
+     * Whether a rule closes the header off from what follows it.
+     *
+     * @returns {boolean} true when the rule renders.
+     */
+    isDivided(): boolean;
+    /**
+     * Whether the consumer filled the trailing region.
+     *
+     * @returns {boolean} true when the actions slot carries content.
+     */
+    hasActions(): boolean;
+    /**
+     * Extract the element the heading renders as.
+     *
+     * @returns {string} Heading tag name.
+     */
+    extractHeadingTag(): string;
+    /**
+     * Build the parcel handed to the rule.
+     *
+     * The rule is decorative: the heading already tells a screen reader where the
+     * boundary is, so announcing it twice adds nothing.
+     *
+     * @returns {{
+     *   orientation: 'horizontal'
+     *   decorative: boolean
+     * }} Separator parcel.
+     */
+    buildDividerParcel(): {
+        orientation: "horizontal";
+        decorative: boolean;
+    };
+    /**
+     * Extract CSS class map for the root.
+     *
+     * @returns {Record<string, boolean>} Class map.
+     */
+    extractRootClassNames(): Record<string, boolean>;
+    /**
+     * Extract attributes forwarded to the root element.
+     *
+     * @returns {Record<string, *>} Passthrough attributes.
+     */
+    extractRootAttributes(): Record<string, any>;
+}
+export type FuroSectionHeaderSize = "large" | "medium";
+export type Props = {
+    parcel: FuroSectionHeaderParcel | null;
+};
+export type FuroSectionHeaderParcel = {
+    title?: string;
+    headingLevel?: number;
+    size?: FuroSectionHeaderSize;
+    divided?: boolean;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';