@omni-design/components 0.11.0 → 0.13.0

package/dist/types/docs/componentsSurfaces.d.ts

@@ -0,0 +1,429 @@
+export namespace ICON_DOC {
+    let name: string;
+    let summary: string;
+    let insteadUse: {
+        when: string;
+        use: string;
+    }[];
+    let props: ({
+        name: string;
+        type: string;
+        default: string;
+        values: string[];
+        note: string;
+    } | {
+        name: string;
+        type: string;
+        values: string[];
+        default: string;
+        note?: undefined;
+    } | {
+        name: string;
+        type: string;
+        default: string;
+        note: string;
+        values?: undefined;
+    } | {
+        name: string;
+        type: string;
+        default: string;
+        values?: undefined;
+        note?: undefined;
+    })[];
+    let states: {
+        state: string;
+        setBy: string;
+        note: string;
+    }[];
+    let theming: {
+        collection: string;
+        inCode: string;
+        inFigma: string;
+    }[];
+    let themingNotes: string[];
+    let tokens: {
+        name: string;
+        sets: string;
+        variesWith: string;
+        figma: string;
+    }[];
+    let composition: string[];
+    let accessibility: string[];
+    let gotchas: string[];
+}
+export namespace FAB_DOC {
+    let name_1: string;
+    export { name_1 as name };
+    let summary_1: string;
+    export { summary_1 as summary };
+    let insteadUse_1: {
+        when: string;
+        use: string;
+    }[];
+    export { insteadUse_1 as insteadUse };
+    let props_1: ({
+        name: string;
+        type: string;
+        default: string;
+        note?: undefined;
+        values?: undefined;
+    } | {
+        name: string;
+        type: string;
+        default: string;
+        note: string;
+        values?: undefined;
+    } | {
+        name: string;
+        type: string;
+        values: string[];
+        default: string;
+        note?: undefined;
+    } | {
+        name: string;
+        type: string;
+        values: string[];
+        default: string;
+        note: string;
+    })[];
+    export { props_1 as props };
+    let states_1: ({
+        state: string;
+        setBy: string;
+        note: string;
+    } | {
+        state: string;
+        setBy: string;
+        note?: undefined;
+    })[];
+    export { states_1 as states };
+    let theming_1: {
+        collection: string;
+        inCode: string;
+        inFigma: string;
+    }[];
+    export { theming_1 as theming };
+    let themingNotes_1: string[];
+    export { themingNotes_1 as themingNotes };
+    let tokens_1: {
+        name: string;
+        sets: string;
+        variesWith: string;
+        figma: string;
+    }[];
+    export { tokens_1 as tokens };
+    let composition_1: string[];
+    export { composition_1 as composition };
+    let accessibility_1: string[];
+    export { accessibility_1 as accessibility };
+    let gotchas_1: string[];
+    export { gotchas_1 as gotchas };
+}
+export namespace SNACKBAR_DOC {
+    let name_2: string;
+    export { name_2 as name };
+    let summary_2: string;
+    export { summary_2 as summary };
+    let insteadUse_2: {
+        when: string;
+        use: string;
+    }[];
+    export { insteadUse_2 as insteadUse };
+    let props_2: ({
+        name: string;
+        type: string;
+        default: string;
+        values?: undefined;
+        note?: undefined;
+    } | {
+        name: string;
+        type: string;
+        values: string[];
+        default: string;
+        note?: undefined;
+    } | {
+        name: string;
+        type: string;
+        default: string;
+        note: string;
+        values?: undefined;
+    })[];
+    export { props_2 as props };
+    let states_2: ({
+        state: string;
+        setBy: string;
+        note?: undefined;
+    } | {
+        state: string;
+        setBy: string;
+        note: string;
+    })[];
+    export { states_2 as states };
+    let theming_2: {
+        collection: string;
+        inCode: string;
+        inFigma: string;
+    }[];
+    export { theming_2 as theming };
+    let tokens_2: {
+        name: any;
+        sets: any;
+        variesWith: string;
+        figma: string;
+    }[];
+    export { tokens_2 as tokens };
+    let composition_2: string[];
+    export { composition_2 as composition };
+    let accessibility_2: string[];
+    export { accessibility_2 as accessibility };
+    let gotchas_2: string[];
+    export { gotchas_2 as gotchas };
+}
+export namespace ACCORDION_DOC {
+    let name_3: string;
+    export { name_3 as name };
+    let summary_3: string;
+    export { summary_3 as summary };
+    let insteadUse_3: {
+        when: string;
+        use: string;
+    }[];
+    export { insteadUse_3 as insteadUse };
+    let props_3: ({
+        name: string;
+        type: string;
+        values: string[];
+        default: string;
+        note?: undefined;
+    } | {
+        name: string;
+        type: string;
+        default: string;
+        values?: undefined;
+        note?: undefined;
+    } | {
+        name: string;
+        type: string;
+        default: string;
+        note: string;
+        values?: undefined;
+    })[];
+    export { props_3 as props };
+    let states_3: ({
+        state: string;
+        setBy: string;
+        note?: undefined;
+    } | {
+        state: string;
+        setBy: string;
+        note: string;
+    })[];
+    export { states_3 as states };
+    let theming_3: {
+        collection: string;
+        inCode: string;
+        inFigma: string;
+    }[];
+    export { theming_3 as theming };
+    let themingNotes_2: string[];
+    export { themingNotes_2 as themingNotes };
+    let tokens_3: {
+        name: any;
+        sets: any;
+        variesWith: string;
+        figma: string;
+    }[];
+    export { tokens_3 as tokens };
+    let composition_3: string[];
+    export { composition_3 as composition };
+    let accessibility_3: string[];
+    export { accessibility_3 as accessibility };
+    let gotchas_3: string[];
+    export { gotchas_3 as gotchas };
+}
+export namespace BRANDICON_DOC {
+    let name_4: string;
+    export { name_4 as name };
+    let summary_4: string;
+    export { summary_4 as summary };
+    let insteadUse_4: {
+        when: string;
+        use: string;
+    }[];
+    export { insteadUse_4 as insteadUse };
+    let props_4: {
+        name: string;
+        type: string;
+        default: string;
+        note: string;
+    }[];
+    export { props_4 as props };
+    let states_4: {
+        state: string;
+        setBy: string;
+        note: string;
+    }[];
+    export { states_4 as states };
+    let theming_4: {
+        collection: string;
+        inCode: string;
+        inFigma: string;
+    }[];
+    export { theming_4 as theming };
+    let themingNotes_3: string[];
+    export { themingNotes_3 as themingNotes };
+    let tokens_4: {
+        name: string;
+        sets: string;
+        variesWith: string;
+        figma: string;
+    }[];
+    export { tokens_4 as tokens };
+    let composition_4: string[];
+    export { composition_4 as composition };
+    let accessibility_4: string[];
+    export { accessibility_4 as accessibility };
+    let gotchas_4: string[];
+    export { gotchas_4 as gotchas };
+    export let changes: any[];
+}
+export const SURFACE_DOCS: ({
+    name: string;
+    summary: string;
+    insteadUse: {
+        when: string;
+        use: string;
+    }[];
+    props: ({
+        name: string;
+        type: string;
+        default: string;
+        note?: undefined;
+        values?: undefined;
+    } | {
+        name: string;
+        type: string;
+        default: string;
+        note: string;
+        values?: undefined;
+    } | {
+        name: string;
+        type: string;
+        values: string[];
+        default: string;
+        note?: undefined;
+    } | {
+        name: string;
+        type: string;
+        values: string[];
+        default: string;
+        note: string;
+    })[];
+    states: ({
+        state: string;
+        setBy: string;
+        note: string;
+    } | {
+        state: string;
+        setBy: string;
+        note?: undefined;
+    })[];
+    theming: {
+        collection: string;
+        inCode: string;
+        inFigma: string;
+    }[];
+    themingNotes: string[];
+    tokens: {
+        name: string;
+        sets: string;
+        variesWith: string;
+        figma: string;
+    }[];
+    composition: string[];
+    accessibility: string[];
+    gotchas: string[];
+} | {
+    name: string;
+    summary: string;
+    insteadUse: {
+        when: string;
+        use: string;
+    }[];
+    props: ({
+        name: string;
+        type: string;
+        default: string;
+        values?: undefined;
+        note?: undefined;
+    } | {
+        name: string;
+        type: string;
+        values: string[];
+        default: string;
+        note?: undefined;
+    } | {
+        name: string;
+        type: string;
+        default: string;
+        note: string;
+        values?: undefined;
+    })[];
+    states: ({
+        state: string;
+        setBy: string;
+        note?: undefined;
+    } | {
+        state: string;
+        setBy: string;
+        note: string;
+    })[];
+    theming: {
+        collection: string;
+        inCode: string;
+        inFigma: string;
+    }[];
+    tokens: {
+        name: any;
+        sets: any;
+        variesWith: string;
+        figma: string;
+    }[];
+    composition: string[];
+    accessibility: string[];
+    gotchas: string[];
+} | {
+    name: string;
+    summary: string;
+    insteadUse: {
+        when: string;
+        use: string;
+    }[];
+    props: {
+        name: string;
+        type: string;
+        default: string;
+        note: string;
+    }[];
+    states: {
+        state: string;
+        setBy: string;
+        note: string;
+    }[];
+    theming: {
+        collection: string;
+        inCode: string;
+        inFigma: string;
+    }[];
+    themingNotes: string[];
+    tokens: {
+        name: string;
+        sets: string;
+        variesWith: string;
+        figma: string;
+    }[];
+    composition: string[];
+    accessibility: string[];
+    gotchas: string[];
+    changes: any[];
+})[];

package/dist/types/docs/docsLink.d.ts

@@ -0,0 +1,32 @@
+/** A component name as it appears in a URL. */
+export function docsSlug(component: any): any;
+/**
+ * Where one component's docs live for one design system.
+ *
+ * A path per component rather than an anchor on a single long page: an anchor
+ * depends on the page rendering headings a browser can jump to, and the
+ * existing /api/tokens/:uuid/md route serves its content into a <pre>, which
+ * has none. A path cannot half-work.
+ */
+export function componentDocsUrl(designSystemId: any, component: any, origin?: string): string;
+/** The index of every component, for the same design system. */
+export function componentDocsIndexUrl(designSystemId: any, origin?: string): string;
+/**
+ * The public URL of one component's reference page.
+ *
+ * Per DESIGN SYSTEM, not per component library: every user imports their own
+ * copy of the .fig and gets their own uuid, so a link baked into the template
+ * would send all of them to whoever built it.
+ *
+ * That splits the two Figma fields:
+ *
+ *   description          generic. Identical for every user, so it can live in
+ *                        the template and be written once.
+ *   documentationLinks   per user. The plugin writes it at import time, when it
+ *                        knows the design system id and nothing else does.
+ *
+ * Any path resolves on the host — `public/_redirects` is `/* /index.html 200`,
+ * a catch-all that hands every URL to the router — so this needs no server
+ * configuration and no anchor.
+ */
+export const DOCS_ORIGIN: "https://omni-design.netlify.app";

package/dist/types/docs/examples.d.ts

@@ -0,0 +1,48 @@
+export function hasExample(component: any): boolean;
+/** Does this component have a sample for this prop? */
+export function hasPropExample(component: any, prop: any): boolean;
+export namespace EXAMPLES {
+    function Button(): JSX.Element;
+    function BrandIcon(): JSX.Element;
+    function Fab(): JSX.Element;
+    function ButtonGroup(): JSX.Element;
+    function Chip(): JSX.Element;
+    function Badge(): JSX.Element;
+    function Alert(): JSX.Element;
+    function Card(): JSX.Element;
+    function Avatar(): JSX.Element;
+    function Icon(): JSX.Element;
+    function Link(): JSX.Element;
+    function Divider(): JSX.Element;
+    function Checkbox(): JSX.Element;
+    function Radio(): JSX.Element;
+    function Input(): JSX.Element;
+    function SwitchInput(): JSX.Element;
+    function Slider(): JSX.Element;
+    function Rating(): JSX.Element;
+    function Breadcrumbs(): JSX.Element;
+    function Pagination(): JSX.Element;
+    function Accordion(): JSX.Element;
+    function Tabs(): JSX.Element;
+}
+export namespace PROP_EXAMPLES {
+    export namespace Fab_1 {
+        function size(): JSX.Element;
+        function color(): JSX.Element;
+        function extended(): JSX.Element;
+        function animate(): JSX.Element;
+        function disabled(): JSX.Element;
+    }
+    export { Fab_1 as Fab };
+    let Button_1: {
+        variant: () => JSX.Element;
+        size: () => JSX.Element;
+        variantColor: () => JSX.Element;
+        disabled: () => JSX.Element;
+        'startDecorator / endDecorator': () => JSX.Element;
+        iconOnly: () => JSX.Element;
+        elevated: () => JSX.Element;
+        fullWidth: () => JSX.Element;
+    };
+    export { Button_1 as Button };
+}

package/dist/types/docs/figmaHowTo.d.ts

@@ -0,0 +1,28 @@
+export namespace FIGMA_HOWTO {
+    namespace Fab {
+        let title: string;
+        let after: string;
+        let node: string;
+        let collection: string;
+        let body: string;
+        let shot: string;
+        let caveat: string;
+    }
+    namespace Button {
+        let title_1: string;
+        export { title_1 as title };
+        let after_1: string;
+        export { after_1 as after };
+        let node_1: string;
+        export { node_1 as node };
+        let collection_1: string;
+        export { collection_1 as collection };
+        let body_1: string;
+        export { body_1 as body };
+        let shot_1: string;
+        export { shot_1 as shot };
+        let caveat_1: string;
+        export { caveat_1 as caveat };
+    }
+}
+export function howToFor(component: any): any;

package/dist/types/docs/figmaLinks.d.ts

@@ -0,0 +1,58 @@
+/**
+ * A link to the component in Figma, or null when it is not drawn.
+ *
+ * Null rather than a link to the file root: a component with no design is a
+ * real answer, and sending someone to the front page to hunt for it is not.
+ */
+export function figmaUrlFor(component: any): string;
+export const FIGMA_FILE_KEY: "Qv2dqF7mYoAGY77EkdrwTv";
+export const FIGMA_FILE_NAME: "Omni-Designs-Aug12";
+export namespace FIGMA_PAGES {
+    let Typography: string;
+    let Accordion: string;
+    let Alert: string;
+    let AppBar: string;
+    let Avatar: string;
+    let Badge: string;
+    let Box: string;
+    let Breadcrumbs: string;
+    let Button: string;
+    let ButtonGroup: string;
+    let Card: string;
+    let Checkbox: string;
+    let Chip: string;
+    let CodeBlock: string;
+    let Dialog: string;
+    let Divider: string;
+    let Drawer: string;
+    let Fab: string;
+    let Icon: string;
+    let IconBadge: string;
+    let Input: string;
+    let Link: string;
+    let List: string;
+    let Loader: string;
+    let Menu: string;
+    let Modal: string;
+    let NumberField: string;
+    let Pagination: string;
+    let Radio: string;
+    let Rail: string;
+    let Ratio: string;
+    let Rating: string;
+    let SearchField: string;
+    let Select: string;
+    let Sheet: string;
+    let Slider: string;
+    let Snackbar: string;
+    let Stepper: string;
+    let SwitchInput: string;
+    let Table: string;
+    let Tabs: string;
+    let Tag: string;
+    let TextField: string;
+    let Toolbar: string;
+    let Tooltip: string;
+    let TreeView: string;
+    let BottomNavigation: string;
+}

package/dist/types/docs/foundations.d.ts

@@ -0,0 +1,40 @@
+export function renderFoundations(): string;
+/**
+ * The facts that are not about any one component.
+ *
+ * Same test as the component docs: every line has to change what an agent
+ * writes. That kept five sections and cut the raw tone ramp — an agent uses
+ * semantic names, and Color-1..Color-12 across nine palettes is generator
+ * internals, volume without decisions.
+ *
+ * The first section exists because the system does the opposite of what every
+ * other one does, and an agent will assume otherwise without being told.
+ */
+export const FOUNDATIONS: ({
+    title: string;
+    lede: string;
+    body: string[];
+    table: {
+        head: string[];
+        rows: string[][];
+    };
+    body2: any[];
+    trap: string;
+} | {
+    title: string;
+    lede: string;
+    body: string[];
+    table: {
+        head: string[];
+        rows: string[][];
+    };
+    trap: string;
+    body2?: undefined;
+} | {
+    title: string;
+    lede: string;
+    body: string[];
+    trap: string;
+    table?: undefined;
+    body2?: undefined;
+})[];

package/dist/types/docs/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./componentDoc";
+export * from "./components";
+export * from "./foundations";
+export * from "./docsLink";
+export { EXAMPLES, hasExample } from "./examples";