@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
83 lines (82 loc) • 2.96 kB
TypeScript
import { NeonOutlineStyle } from '@/common/enums/NeonOutlineStyle';
/**
* An HTML anchor component which handles VueRouter links (internal), href links (external) and clickable links (no href).
*/
declare const _default: import("vue").DefineComponent<{
/**
* 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 <em>text</em> for wrapping text content and
* <em>border</em> for tooltips wrapping "block" elements, e.g. buttons.
*/
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;
};
}, {
routerUrl: import("vue").ComputedRef<string | undefined>;
sanitizedAttributes: import("vue").ComputedRef<{
[x: string]: unknown;
}>;
activeRoute: import("vue").ComputedRef<boolean | "">;
exactRoute: import("vue").ComputedRef<boolean | "">;
onClick: () => void;
onSpace: () => Promise<void>;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "click"[], "click", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, 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 <em>text</em> for wrapping text content and
* <em>border</em> for tooltips wrapping "block" elements, e.g. buttons.
*/
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;
};
}>> & {
onClick?: ((...args: any[]) => any) | undefined;
}, {
href: string;
noStyle: boolean;
outlineStyle: NeonOutlineStyle;
externalIndicator: boolean;
}, {}>;
export default _default;