@iconix/icons 0.0.0-stage → 1.0.0

package/dist/vue-core.d.cts

@@ -0,0 +1,390 @@
+import { type InjectionKey, type Plugin, type PropType, type VNode } from 'vue';
+import type { IconFlip, IconLike, IconLinecap, IconLinejoin, IconName, IconOptions, IconVariant } from './types.cjs';
+export declare const ICON_DEFAULTS_KEY: InjectionKey<IconOptions>;
+/** app.use(IconixPlugin, { size: 20, color: '#2563eb' }) */
+export declare const IconixPlugin: Plugin<[IconOptions?]>;
+/** Inside setup(): sets default options for icons in the subtree. */
+export declare function provideIconDefaults(defaults: IconOptions): void;
+export declare const iconProps: {
+    readonly size: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly width: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly height: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly color: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    readonly fill: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    readonly strokeWidth: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly absoluteStrokeWidth: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly strokeLinecap: {
+        readonly type: PropType<IconLinecap>;
+        readonly default: undefined;
+    };
+    readonly strokeLinejoin: {
+        readonly type: PropType<IconLinejoin>;
+        readonly default: undefined;
+    };
+    readonly variant: {
+        readonly type: PropType<IconVariant>;
+        readonly default: undefined;
+    };
+    readonly background: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    readonly rotate: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly flip: {
+        readonly type: PropType<IconFlip | boolean>;
+        readonly default: undefined;
+    };
+    readonly spin: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly pulse: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly title: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+};
+/** Vue component props (class, style and listeners fall through to <svg> automatically). */
+export type IconVueProps = Omit<IconOptions, 'attrs' | 'style' | 'className'>;
+declare function defineIconComponent(icon: IconLike): import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    readonly size: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly width: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly height: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly color: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    readonly fill: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    readonly strokeWidth: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly absoluteStrokeWidth: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly strokeLinecap: {
+        readonly type: PropType<IconLinecap>;
+        readonly default: undefined;
+    };
+    readonly strokeLinejoin: {
+        readonly type: PropType<IconLinejoin>;
+        readonly default: undefined;
+    };
+    readonly variant: {
+        readonly type: PropType<IconVariant>;
+        readonly default: undefined;
+    };
+    readonly background: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    readonly rotate: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly flip: {
+        readonly type: PropType<IconFlip | boolean>;
+        readonly default: undefined;
+    };
+    readonly spin: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly pulse: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly title: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    readonly size: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly width: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly height: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly color: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    readonly fill: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    readonly strokeWidth: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly absoluteStrokeWidth: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly strokeLinecap: {
+        readonly type: PropType<IconLinecap>;
+        readonly default: undefined;
+    };
+    readonly strokeLinejoin: {
+        readonly type: PropType<IconLinejoin>;
+        readonly default: undefined;
+    };
+    readonly variant: {
+        readonly type: PropType<IconVariant>;
+        readonly default: undefined;
+    };
+    readonly background: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    readonly rotate: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    readonly flip: {
+        readonly type: PropType<IconFlip | boolean>;
+        readonly default: undefined;
+    };
+    readonly spin: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly pulse: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly title: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+}>> & Readonly<{}>, {
+    readonly size: string | number;
+    readonly width: string | number;
+    readonly height: string | number;
+    readonly color: string;
+    readonly fill: string;
+    readonly strokeWidth: string | number;
+    readonly absoluteStrokeWidth: boolean;
+    readonly strokeLinecap: IconLinecap;
+    readonly strokeLinejoin: IconLinejoin;
+    readonly variant: IconVariant;
+    readonly background: string;
+    readonly rotate: string | number;
+    readonly flip: boolean | IconFlip;
+    readonly spin: boolean;
+    readonly pulse: boolean;
+    readonly title: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+/** Type of a single-icon Vue component. */
+export type IconixVueIcon = ReturnType<typeof defineIconComponent>;
+/** Creates a Vue component for any icon object. */
+export declare function createIconComponent(icon: IconLike): IconixVueIcon;
+declare function createNamedIconComponent(): import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    size: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    width: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    height: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    color: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    fill: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    strokeWidth: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    absoluteStrokeWidth: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    strokeLinecap: {
+        readonly type: PropType<IconLinecap>;
+        readonly default: undefined;
+    };
+    strokeLinejoin: {
+        readonly type: PropType<IconLinejoin>;
+        readonly default: undefined;
+    };
+    variant: {
+        readonly type: PropType<IconVariant>;
+        readonly default: undefined;
+    };
+    background: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    rotate: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    flip: {
+        readonly type: PropType<IconFlip | boolean>;
+        readonly default: undefined;
+    };
+    spin: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    pulse: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    title: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    name: {
+        type: PropType<IconName | IconLike>;
+        required: true;
+    };
+}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    size: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    width: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    height: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    color: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    fill: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    strokeWidth: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    absoluteStrokeWidth: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    strokeLinecap: {
+        readonly type: PropType<IconLinecap>;
+        readonly default: undefined;
+    };
+    strokeLinejoin: {
+        readonly type: PropType<IconLinejoin>;
+        readonly default: undefined;
+    };
+    variant: {
+        readonly type: PropType<IconVariant>;
+        readonly default: undefined;
+    };
+    background: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    rotate: {
+        readonly type: PropType<number | string>;
+        readonly default: undefined;
+    };
+    flip: {
+        readonly type: PropType<IconFlip | boolean>;
+        readonly default: undefined;
+    };
+    spin: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    pulse: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    title: {
+        readonly type: StringConstructor;
+        readonly default: undefined;
+    };
+    name: {
+        type: PropType<IconName | IconLike>;
+        required: true;
+    };
+}>> & Readonly<{}>, {
+    size: string | number;
+    width: string | number;
+    height: string | number;
+    color: string;
+    fill: string;
+    strokeWidth: string | number;
+    absoluteStrokeWidth: boolean;
+    strokeLinecap: IconLinecap;
+    strokeLinejoin: IconLinejoin;
+    variant: IconVariant;
+    background: string;
+    rotate: string | number;
+    flip: boolean | IconFlip;
+    spin: boolean;
+    pulse: boolean;
+    title: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+/** <Icon name="home" /> – icon by name (bundles all icons). */
+export declare const Icon: ReturnType<typeof createNamedIconComponent>;
+export {};