@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
138 lines (137 loc) • 4.74 kB
TypeScript
import { NeonOutlineStyle } from '@/model/common/accessibility/NeonOutlineStyle';
/**
* An HTML anchor component which handles VueRouter links (internal), href links (external) and clickable links (no href).
*/
declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
/**
* The href of the link, this can be an internal (relative or absolute) or an external link.
*/
href: {
type: StringConstructor;
default: null;
};
/**
* set to true if you would like a completely unstyled link. This is useful for creating a complex component which may use NeonLink.
*/
noStyle: {
type: BooleanConstructor;
default: boolean;
};
/**
* Style of the outline to use when the link has focus, use this in combination with the <em>no-style</em> flag to
* style the outline of non-text links.
*/
outlineStyle: {
type: () => NeonOutlineStyle;
default: NeonOutlineStyle;
};
/**
* Display an external link icon to the right of the link indicating clicking it will take the user to another site.
*/
externalIndicator: {
type: BooleanConstructor;
default: boolean;
};
}>, {
neonLink: import("vue").Ref<HTMLAnchorElement | null, HTMLAnchorElement | null>;
routerUrl: import("vue").ComputedRef<string | undefined>;
sanitizedAttributes: import("vue").ComputedRef<{
[x: string]: unknown;
}>;
activeRoute: import("vue").ComputedRef<boolean | "" | undefined>;
exactRoute: import("vue").ComputedRef<boolean | "" | undefined>;
onClick: () => void;
onSpace: () => Promise<void>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "click"[], "click", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
/**
* The href of the link, this can be an internal (relative or absolute) or an external link.
*/
href: {
type: StringConstructor;
default: null;
};
/**
* set to true if you would like a completely unstyled link. This is useful for creating a complex component which may use NeonLink.
*/
noStyle: {
type: BooleanConstructor;
default: boolean;
};
/**
* Style of the outline to use when the link has focus, use this in combination with the <em>no-style</em> flag to
* style the outline of non-text links.
*/
outlineStyle: {
type: () => NeonOutlineStyle;
default: NeonOutlineStyle;
};
/**
* Display an external link icon to the right of the link indicating clicking it will take the user to another site.
*/
externalIndicator: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{
onClick?: ((...args: any[]) => any) | undefined;
}>, {
href: string;
noStyle: boolean;
outlineStyle: NeonOutlineStyle;
externalIndicator: boolean;
}, {}, {
NeonIcon: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
name: {
type: StringConstructor;
required: true;
};
id: {
type: StringConstructor;
default: null;
};
color: {
type: () => import("../../../neon").NeonFunctionalColor;
default: null;
};
inverse: {
type: BooleanConstructor;
default: boolean;
};
disabled: {
type: BooleanConstructor;
default: boolean;
};
}>, {
sanitizedAttributes: import("vue").ComputedRef<{
[x: string]: unknown;
}>;
icon: import("vue").ComputedRef<string | undefined>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
name: {
type: StringConstructor;
required: true;
};
id: {
type: StringConstructor;
default: null;
};
color: {
type: () => import("../../../neon").NeonFunctionalColor;
default: null;
};
inverse: {
type: BooleanConstructor;
default: boolean;
};
disabled: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
color: import("../../../neon").NeonFunctionalColor;
id: string;
inverse: boolean;
disabled: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;