@aotearoan/neon 9.2.9 → 9.3.0

package/dist/src/components/user-input/slider/NeonSlider.d.ts

@@ -0,0 +1,281 @@
+import { NeonFunctionalColor } from '@/common/enums/NeonFunctionalColor';
+/**
+ * <p>
+ *   The <strong>NeonSlider</strong> component is the equivalent of an <strong>&lt;input type="range" /&gt;</strong>. In
+ *   addition to this, there is support for automatic formatting the min, max and selected value plus options for
+ *   percentage formatting and providing custom templates, e.g. currency formatting.
+ * </p>
+ * <p><strong>NeonNumber</strong> also supports all relevant properties found on an HTML &lt;input&gt;.</p>
+ */
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The current input <em>value</em>.
+     */
+    modelValue: {
+        type: NumberConstructor;
+        required: true;
+    };
+    /**
+     * id of the range input.
+     */
+    id: {
+        type: StringConstructor;
+        required: false;
+    };
+    /**
+     * Slider color.
+     */
+    color: {
+        type: () => NeonFunctionalColor;
+        default: NeonFunctionalColor;
+    };
+    /**
+     * The locale used for display purposes. This defaults to the browser's locale if none is provided.
+     */
+    locale: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Show/hide the output.
+     */
+    output: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Show/hide the legend.
+     */
+    legend: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Show/hide the tooltip.
+     */
+    tooltip: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Automatically applies % formatting, e.g. if the value = 0.15 it will be displayed as 15%.
+     */
+    percentage: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The size of steps between values the user can select. The default value is 1 except when percentage = true the
+     * default is 0.01 (1%).
+     */
+    step: {
+        type: NumberConstructor;
+        required: false;
+    };
+    /**
+     * The rounding precision for display purposes.
+     */
+    decimals: {
+        type: NumberConstructor;
+        required: false;
+    };
+    /**
+     * A template string used for formatting the display value. Use the placeholder {value} to reference the value in the
+     * template string. e.g. value = 90, ${value} => $90.
+     */
+    valueTemplate: {
+        type: StringConstructor;
+        required: false;
+    };
+    /**
+     * Disable formatting, e.g. in the case of a year value -> display as 2020, not 2,020.
+     */
+    disableFormatting: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The minimum range value.
+     */
+    min: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * The maximum range value. The default value is 100 except when percentage = true the default is 1 (100%).
+     */
+    max: {
+        type: NumberConstructor;
+        required: false;
+    };
+    /**
+     * The lower bound within the range of values.
+     * @ignore
+     */
+    lowerBound: {
+        type: NumberConstructor;
+        required: false;
+    };
+    /**
+     * The upper bound within the range of values.
+     * @ignore
+     */
+    upperBound: {
+        type: NumberConstructor;
+        required: false;
+    };
+    /**
+     * Component disabled state.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, {
+    sanitizedAttributes: import("vue").ComputedRef<{
+        [x: string]: unknown;
+    }>;
+    formattedMin: import("vue").ComputedRef<string | number>;
+    formattedMax: import("vue").ComputedRef<string | number>;
+    formattedValue: import("vue").ComputedRef<string | number>;
+    computedMax: import("vue").ComputedRef<number>;
+    computedStep: import("vue").ComputedRef<number>;
+    changeValue: (event: Event) => 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<{
+    /**
+     * The current input <em>value</em>.
+     */
+    modelValue: {
+        type: NumberConstructor;
+        required: true;
+    };
+    /**
+     * id of the range input.
+     */
+    id: {
+        type: StringConstructor;
+        required: false;
+    };
+    /**
+     * Slider color.
+     */
+    color: {
+        type: () => NeonFunctionalColor;
+        default: NeonFunctionalColor;
+    };
+    /**
+     * The locale used for display purposes. This defaults to the browser's locale if none is provided.
+     */
+    locale: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Show/hide the output.
+     */
+    output: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Show/hide the legend.
+     */
+    legend: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Show/hide the tooltip.
+     */
+    tooltip: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Automatically applies % formatting, e.g. if the value = 0.15 it will be displayed as 15%.
+     */
+    percentage: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The size of steps between values the user can select. The default value is 1 except when percentage = true the
+     * default is 0.01 (1%).
+     */
+    step: {
+        type: NumberConstructor;
+        required: false;
+    };
+    /**
+     * The rounding precision for display purposes.
+     */
+    decimals: {
+        type: NumberConstructor;
+        required: false;
+    };
+    /**
+     * A template string used for formatting the display value. Use the placeholder {value} to reference the value in the
+     * template string. e.g. value = 90, ${value} => $90.
+     */
+    valueTemplate: {
+        type: StringConstructor;
+        required: false;
+    };
+    /**
+     * Disable formatting, e.g. in the case of a year value -> display as 2020, not 2,020.
+     */
+    disableFormatting: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The minimum range value.
+     */
+    min: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * The maximum range value. The default value is 100 except when percentage = true the default is 1 (100%).
+     */
+    max: {
+        type: NumberConstructor;
+        required: false;
+    };
+    /**
+     * The lower bound within the range of values.
+     * @ignore
+     */
+    lowerBound: {
+        type: NumberConstructor;
+        required: false;
+    };
+    /**
+     * The upper bound within the range of values.
+     * @ignore
+     */
+    upperBound: {
+        type: NumberConstructor;
+        required: false;
+    };
+    /**
+     * Component disabled state.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {
+    legend: boolean;
+    output: boolean;
+    color: NeonFunctionalColor;
+    tooltip: boolean;
+    disabled: boolean;
+    locale: string;
+    min: number;
+    percentage: boolean;
+    disableFormatting: boolean;
+}>;
+export default _default;

package/dist/src/components/user-input/slider/NeonSlider.vue.d.ts

@@ -0,0 +1,2 @@
+export * from './NeonSlider.js';
+export { default } from './NeonSlider.js';

package/dist/src/components/user-input/switch/NeonSwitch.d.ts

@@ -0,0 +1,143 @@
+import { NeonSize } from '@/common/enums/NeonSize';
+import { NeonFunctionalColor } from '@/common/enums/NeonFunctionalColor';
+import { NeonSwitchStyle } from '@/common/enums/NeonSwitchStyle';
+import { NeonHorizontalPosition } from '@/common/enums/NeonHorizontalPosition';
+/**
+ * <p>
+ * A Switch or Checkbox component used to indicate an on/off state. This is equivalent to a checkbox. The switch supports
+ * both <em>Switch</em> and <em>Checkbox</em> styles which can be used in different scenarios.
+ * </p>
+ */
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The switch model.
+     */
+    modelValue: {
+        type: BooleanConstructor;
+        required: true;
+    };
+    /**
+     * The switch label, the label can be optional only in the case the switch is part of a more complex component.
+     */
+    label: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * The indeterminate state of the checkbox.
+     */
+    indeterminate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The size of the switch.
+     */
+    size: {
+        type: () => NeonSize;
+        default: () => NeonSize;
+    };
+    /**
+     * The switch color.
+     */
+    color: {
+        type: () => NeonFunctionalColor;
+        default: () => NeonFunctionalColor;
+    };
+    /**
+     * Style the switch as a <em>Switch</em> or a <em>Checkbox</em>.
+     */
+    switchStyle: {
+        type: () => NeonSwitchStyle;
+        default: () => NeonSwitchStyle;
+    };
+    /**
+     * The position of the switch label.
+     */
+    labelPosition: {
+        type: () => NeonHorizontalPosition;
+        default: () => NeonHorizontalPosition;
+    };
+    /**
+     * Disabled state of the switch.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, {
+    checkbox: import("vue").Ref<HTMLInputElement | null>;
+    sanitizedAttributes: import("vue").ComputedRef<{
+        [x: string]: unknown;
+    }>;
+    toggleSwitch: () => void;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "indeterminate-change")[], "update:modelValue" | "indeterminate-change", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The switch model.
+     */
+    modelValue: {
+        type: BooleanConstructor;
+        required: true;
+    };
+    /**
+     * The switch label, the label can be optional only in the case the switch is part of a more complex component.
+     */
+    label: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * The indeterminate state of the checkbox.
+     */
+    indeterminate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The size of the switch.
+     */
+    size: {
+        type: () => NeonSize;
+        default: () => NeonSize;
+    };
+    /**
+     * The switch color.
+     */
+    color: {
+        type: () => NeonFunctionalColor;
+        default: () => NeonFunctionalColor;
+    };
+    /**
+     * Style the switch as a <em>Switch</em> or a <em>Checkbox</em>.
+     */
+    switchStyle: {
+        type: () => NeonSwitchStyle;
+        default: () => NeonSwitchStyle;
+    };
+    /**
+     * The position of the switch label.
+     */
+    labelPosition: {
+        type: () => NeonHorizontalPosition;
+        default: () => NeonHorizontalPosition;
+    };
+    /**
+     * Disabled state of the switch.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onIndeterminate-change"?: ((...args: any[]) => any) | undefined;
+}, {
+    label: string;
+    color: NeonFunctionalColor;
+    disabled: boolean;
+    size: NeonSize;
+    indeterminate: boolean;
+    switchStyle: NeonSwitchStyle;
+    labelPosition: NeonHorizontalPosition;
+}>;
+export default _default;

package/dist/src/components/user-input/switch/NeonSwitch.vue.d.ts

@@ -0,0 +1,2 @@
+export * from './NeonSwitch.js';
+export { default } from './NeonSwitch.js';

package/dist/src/components/user-input/toggle/NeonToggle.d.ts

@@ -0,0 +1,138 @@
+import type { NeonToggleModel } from '@/common/models/NeonToggleModel';
+import { NeonSize } from '@/common/enums/NeonSize';
+import { NeonFunctionalColor } from '@/common/enums/NeonFunctionalColor';
+import { NeonToggleStyle } from '@/common/enums/NeonToggleStyle';
+import { NeonOrientation } from '@/common/enums/NeonOrientation';
+/**
+ * <p>A toggle component for selecting one value from a range of options. This is equivalent to a radio button group. It can be styled as a <em>Toggle</em> or as <em>Radio buttons</em>.
+ */
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The name of the radio button group.
+     */
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The key of the selected option.
+     */
+    modelValue: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The list of options to present to the user.
+     */
+    model: {
+        type: () => Array<NeonToggleModel>;
+        required: true;
+    };
+    /**
+     * The style of toggle to display to the user.
+     */
+    toggleStyle: {
+        type: () => NeonToggleStyle;
+        default: () => NeonToggleStyle;
+    };
+    /**
+     * The size of the toggle.
+     */
+    size: {
+        type: () => NeonSize;
+        default: () => NeonSize;
+    };
+    /**
+     * The orientation of the toggle if the style is a radio button group.
+     */
+    orientation: {
+        type: () => NeonOrientation;
+        default: () => NeonOrientation;
+    };
+    /**
+     * The color of the toggle.
+     */
+    color: {
+        type: () => NeonFunctionalColor;
+        default: () => NeonFunctionalColor;
+    };
+    /**
+     * Whether the toggle is disabled.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, {
+    selectOption: (option: NeonToggleModel) => void;
+    onInput: (key: string) => void;
+    sanitizedAttributes: import("vue").ComputedRef<{
+        [x: string]: unknown;
+    }>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The name of the radio button group.
+     */
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The key of the selected option.
+     */
+    modelValue: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The list of options to present to the user.
+     */
+    model: {
+        type: () => Array<NeonToggleModel>;
+        required: true;
+    };
+    /**
+     * The style of toggle to display to the user.
+     */
+    toggleStyle: {
+        type: () => NeonToggleStyle;
+        default: () => NeonToggleStyle;
+    };
+    /**
+     * The size of the toggle.
+     */
+    size: {
+        type: () => NeonSize;
+        default: () => NeonSize;
+    };
+    /**
+     * The orientation of the toggle if the style is a radio button group.
+     */
+    orientation: {
+        type: () => NeonOrientation;
+        default: () => NeonOrientation;
+    };
+    /**
+     * The color of the toggle.
+     */
+    color: {
+        type: () => NeonFunctionalColor;
+        default: () => NeonFunctionalColor;
+    };
+    /**
+     * Whether the toggle is disabled.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {
+    color: NeonFunctionalColor;
+    disabled: boolean;
+    size: NeonSize;
+    orientation: NeonOrientation;
+    toggleStyle: NeonToggleStyle;
+}>;
+export default _default;

package/dist/src/components/user-input/toggle/NeonToggle.vue.d.ts

@@ -0,0 +1,2 @@
+export * from './NeonToggle.js';
+export { default } from './NeonToggle.js';

package/dist/src/components/user-input/toggle-chip/NeonToggleChip.d.ts

@@ -0,0 +1,110 @@
+import { NeonSize } from '@/common/enums/NeonSize';
+import { NeonFunctionalColor } from '@/common/enums/NeonFunctionalColor';
+/**
+ * <p>
+ * A Toggle chip component used to indicate an on/off state in form inputs. This is equivalent to a checkbox. This is a
+ * variation of a checkbox/switch which can be used as an on/off button to trigger an action or used in a group for
+ * filtering.
+ * </p>
+ */
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The toggle chip model.
+     */
+    modelValue: {
+        type: BooleanConstructor;
+        required: true;
+    };
+    /**
+     * The toggle label.
+     */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The size of the toggle chip.
+     */
+    size: {
+        type: () => NeonSize;
+        default: NeonSize;
+    };
+    /**
+     * The toggle chip color.
+     */
+    color: {
+        type: () => NeonFunctionalColor;
+        default: NeonFunctionalColor;
+    };
+    /**
+     * Whether to display a checked icon on the toggle chip when it is 'on'.
+     */
+    showCheck: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Disabled state of the toggle chip.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, {
+    sanitizedAttributes: import("vue").ComputedRef<{
+        [x: string]: unknown;
+    }>;
+    emitInput: (value: boolean) => void;
+    toggleChip: () => 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<{
+    /**
+     * The toggle chip model.
+     */
+    modelValue: {
+        type: BooleanConstructor;
+        required: true;
+    };
+    /**
+     * The toggle label.
+     */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The size of the toggle chip.
+     */
+    size: {
+        type: () => NeonSize;
+        default: NeonSize;
+    };
+    /**
+     * The toggle chip color.
+     */
+    color: {
+        type: () => NeonFunctionalColor;
+        default: NeonFunctionalColor;
+    };
+    /**
+     * Whether to display a checked icon on the toggle chip when it is 'on'.
+     */
+    showCheck: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Disabled state of the toggle chip.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {
+    color: NeonFunctionalColor;
+    disabled: boolean;
+    size: NeonSize;
+    showCheck: boolean;
+}>;
+export default _default;

package/dist/src/components/user-input/toggle-chip/NeonToggleChip.vue.d.ts

@@ -0,0 +1,2 @@
+export * from './NeonToggleChip.js';
+export { default } from './NeonToggleChip.js';