@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
154 lines (153 loc) • 4.42 kB
TypeScript
import { NeonVerticalPosition } from '@/common/enums/NeonVerticalPosition';
import { NeonSize } from '@/common/enums/NeonSize';
import { NeonFunctionalColor } from '@/common/enums/NeonFunctionalColor';
/**
* <p>Expansion panels are used to show and hide content that may be less important or too large to display on screen
* all the time. They can also be used to expand lists of items, e.g. <em>Show more</em>. The expansion panel consists
* of a button which, when clicked, toggles the open/closed state of the expansion panel and a slot for the content to
* display on expansion.</p>
*/
declare const _default: import("vue").DefineComponent<{
/**
* A boolean indicating whether the expansion panel is expanded.
*/
modelValue: {
type: BooleanConstructor;
required: true;
};
/**
* The label of the expansion button
*/
label: {
type: StringConstructor;
required: true;
};
/**
* Provide an id to support aria-controls. The id will be placed on the expansion panel content wrapper and the
* aria-controls on the header (triggering the expansion).
*/
id: {
type: StringConstructor;
default: null;
};
/**
* An icon to display to the left of the label
*/
icon: {
type: StringConstructor;
default: null;
};
/**
* The position of the expansion button. This can be located above the content to expand or below it.
*/
position: {
type: () => NeonVerticalPosition;
default: NeonVerticalPosition;
};
/**
* The size of the expansion panel button.
*/
size: {
type: () => NeonSize;
default: NeonSize;
};
/**
* The color of the expansion panel button.
*/
color: {
type: () => NeonFunctionalColor;
default: NeonFunctionalColor;
};
/**
* Whether the label and expansion indicator should be flush with the width of the container.
*/
fullWidth: {
type: BooleanConstructor;
default: boolean;
};
/**
* The disabled state of the expansion panel
*/
disabled: {
type: BooleanConstructor;
default: boolean;
};
}, {
toggleExpanded: () => void;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
/**
* A boolean indicating whether the expansion panel is expanded.
*/
modelValue: {
type: BooleanConstructor;
required: true;
};
/**
* The label of the expansion button
*/
label: {
type: StringConstructor;
required: true;
};
/**
* Provide an id to support aria-controls. The id will be placed on the expansion panel content wrapper and the
* aria-controls on the header (triggering the expansion).
*/
id: {
type: StringConstructor;
default: null;
};
/**
* An icon to display to the left of the label
*/
icon: {
type: StringConstructor;
default: null;
};
/**
* The position of the expansion button. This can be located above the content to expand or below it.
*/
position: {
type: () => NeonVerticalPosition;
default: NeonVerticalPosition;
};
/**
* The size of the expansion panel button.
*/
size: {
type: () => NeonSize;
default: NeonSize;
};
/**
* The color of the expansion panel button.
*/
color: {
type: () => NeonFunctionalColor;
default: NeonFunctionalColor;
};
/**
* Whether the label and expansion indicator should be flush with the width of the container.
*/
fullWidth: {
type: BooleanConstructor;
default: boolean;
};
/**
* The disabled state of the expansion panel
*/
disabled: {
type: BooleanConstructor;
default: boolean;
};
}>> & {
"onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
}, {
disabled: boolean;
icon: string;
size: NeonSize;
color: NeonFunctionalColor;
id: string;
fullWidth: boolean;
position: NeonVerticalPosition;
}, {}>;
export default _default;