@fewangsit/wangsvue-fats 1.0.0-alpha.31 → 1.0.0-alpha.33

package/components/toast/Toast.vue.d.ts

@@ -0,0 +1,367 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ *
+ * Toast is used to display messages in an overlay.
+ *
+ * [Live Demo](https://www.WangsVue.org/toast/)
+ *
+ * @module toast
+ *
+ */
+import { TransitionProps, VNode } from 'vue';
+import { ComponentHooks } from '../basecomponent';
+import { PassThroughOptions } from '../passthrough';
+import {
+    ClassComponent,
+    GlobalComponentConstructor,
+    PassThrough,
+} from '../ts-helpers';
+import { WangsIcons } from '../icon/Icon.vue.d';
+
+export declare type ToastPassThroughOptionType =
+    | ToastPassThroughAttributes
+    | ((
+          options: ToastPassThroughMethodOptions,
+      ) => ToastPassThroughAttributes | string)
+    | string
+    | null
+    | undefined;
+
+export declare type ToastPassThroughTransitionType =
+    | TransitionProps
+    | ((options: ToastPassThroughMethodOptions) => TransitionProps)
+    | undefined;
+
+/**
+ * Custom passthrough(pt) option method.
+ */
+export interface ToastPassThroughMethodOptions {
+    /**
+     * Defines instance.
+     */
+    instance: any;
+    /**
+     * Defines valid properties.
+     */
+    props: ToastProps;
+    /**
+     * Defines current inline state.
+     */
+    state: ToastState;
+    /**
+     * Defines valid attributes.
+     */
+    attrs: any;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
+    /**
+     * Defines passthrough(pt) options in global config.
+     */
+    global: object | undefined;
+}
+
+/**
+ * Custom passthrough(pt) options.
+ * @see {@link ToastProps.pt}
+ */
+export interface ToastPassThroughOptions {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: ToastPassThroughOptionType;
+    /**
+     * Used to pass attributes to the message's DOM element.
+     */
+    message?: ToastPassThroughOptionType;
+    /**
+     * Used to pass attributes to the container's DOM element.
+     */
+    container?: ToastPassThroughOptionType;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: ToastPassThroughOptionType;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: ToastPassThroughOptionType;
+    /**
+     * Used to pass attributes to the text's DOM element.
+     */
+    text?: ToastPassThroughOptionType;
+    /**
+     * Used to pass attributes to the summary's DOM element.
+     */
+    summary?: ToastPassThroughOptionType;
+    /**
+     * Used to pass attributes to the detail's DOM element.
+     */
+    detail?: ToastPassThroughOptionType;
+    /**
+     * Used to pass attributes to the button container's DOM element.
+     */
+    buttonContainer?: ToastPassThroughOptionType;
+    /**
+     * Used to pass attributes to the button's DOM element.
+     * @deprecated since v3.30.2. Use 'closeButton' option.
+     */
+    button?: ToastPassThroughOptionType;
+    /**
+     * Used to pass attributes to the button's DOM element.
+     */
+    closeButton?: ToastPassThroughOptionType;
+    /**
+     * Used to pass attributes to the button icon's DOM element.
+     * @deprecated since v3.30.2. Use 'closeIcon' option.
+     */
+    buttonIcon?: ToastPassThroughOptionType;
+    /**
+     * Used to pass attributes to the button icon's DOM element.
+     */
+    closeIcon?: ToastPassThroughOptionType;
+    /**
+     * Used to manage all lifecycle hooks.
+     * @see {@link BaseComponent.ComponentHooks}
+     */
+    hooks?: ComponentHooks;
+    /**
+     * Used to control Vue Transition API.
+     */
+    transition?: ToastPassThroughTransitionType;
+}
+
+/**
+ * Custom passthrough attributes for each DOM elements
+ */
+export interface ToastPassThroughAttributes {
+    [key: string]: any;
+}
+
+/**
+ * Defines message options in Toast component.
+ */
+export interface ToastMessageOptions {
+    /**
+     * Severity level of the message.
+     * @defaultValue info
+     */
+    severity?:
+        | 'success'
+        | 'info'
+        | 'warn'
+        | 'error'
+        | 'secondary'
+        | 'contrast'
+        | undefined;
+    /**
+     * Summary content of the message.
+     */
+    summary?: string | undefined;
+    /**
+     * Detail content of the message.
+     */
+    detail?: any | undefined;
+    /**
+     * Whether the message can be closed manually using the close icon.
+     * @defaultValue true
+     */
+    closable?: boolean | undefined;
+    /**
+     * Delay in milliseconds to close the message automatically.
+     */
+    life?: number | undefined;
+    /**
+     * Key of the Toast to display the message.
+     */
+    group?: string | undefined;
+    /**
+     * Style class of the message.
+     */
+    styleClass?: any;
+    /**
+     * Style class of the content.
+     */
+    contentStyleClass?: any;
+}
+
+/**
+ * Defines breakpoints type in Toast component.
+ */
+export interface ToastBreakpointsType {
+    /**
+     * Breakpoint for responsive mode.
+     *
+     * Example:
+     *
+     * <Toast :breakpoints="{'960px': { width: '75vw', ... }" ... />
+     *
+     */
+    [key: string]: any;
+}
+
+/**
+ * Defines current inline state in Toast component.
+ */
+export interface ToastState {
+    /**
+     * Current messages.
+     */
+    messages: any[];
+}
+
+/**
+ * Defines valid properties in Toast component.
+ */
+export interface ToastProps {
+    /**
+     * Unique identifier of a message group.
+     */
+    group?: string | undefined;
+    /**
+     * Position of the toast in viewport.
+     * @defaultValue bottom-right
+     */
+    position?:
+        | 'top-left'
+        | 'top-center'
+        | 'top-right'
+        | 'bottom-left'
+        | 'bottom-center'
+        | 'bottom-right'
+        | 'center'
+        | undefined;
+    /**
+     * Whether to automatically manage layering.
+     * @defaultValue true
+     */
+    autoZIndex?: boolean | undefined;
+    /**
+     * Base zIndex value to use in layering.
+     * @defaultValue 0
+     */
+    baseZIndex?: number | undefined;
+    /**
+     * Object literal to define styles per screen size.
+     * @see ToastBreakpointsType
+     */
+    breakpoints?: ToastBreakpointsType;
+    /**
+     * Used to access message options.
+     * @type {ToastMessageOptions}
+     */
+    message?: ToastMessageOptions;
+    icon?: WangsIcons;
+    /**
+     * Used to pass attributes to DOM elements inside the component.
+     * @type {ToastPassThroughOptions}
+     */
+    pt?: PassThrough<ToastPassThroughOptions>;
+    /**
+     * Used to configure passthrough(pt) options of the component.
+     * @type {PassThroughOptions}
+     */
+    ptOptions?: PassThroughOptions;
+    /**
+     * When enabled, it removes component related styles in the core.
+     * @defaultValue false
+     */
+    unstyled?: boolean;
+}
+
+/**
+ * Defines valid slot in Toast component.
+ */
+export interface ToastSlots {
+    /**
+     * Custom message template.
+     * @param {Object} scope - message slot's params.
+     */
+    message(scope: {
+        /**
+         * Message of the component
+         */
+        message: any;
+    }): VNode[];
+    /**
+     * Custom icon template.
+     * @param {Object} scope - icon slot's params.
+     */
+    icon(scope: {
+        /**
+         * Style class of the icon
+         */
+        class: any;
+    }): VNode[];
+    /**
+     * Custom close icon template.
+     * @param {Object} scope - close icon slot's params.
+     */
+    closeicon(scope: {
+        /**
+         * Style class of the close icon
+         */
+        class: any;
+    }): VNode[];
+    /**
+     * Custom container slot.
+     * @param {Object} scope - container slot's params.
+     */
+    container(scope: {
+        /**
+         * Message of the component
+         */
+        message: any;
+        /**
+         * Close toast function
+         * @deprecated since v3.39.0. Use 'closeCallback' property instead.
+         */
+        onClose: () => void;
+        /**
+         * Close sidebar function.
+         */
+        closeCallback: () => void;
+    }): VNode[];
+}
+
+/**
+ * Defines valid emits in Toast component.
+ */
+export type ToastEmits = {
+    /**
+     * Callback to invoke when the toast is closed.
+     * @param {ToastMessageOptions} message - Toast message.
+     */
+    close: [message: ToastMessageOptions];
+    /**
+     * Callback to invoke when the toast's timeout is over.
+     * @param {ToastMessageOptions} message - Toast message.
+     */
+    lifeEnd: [message: ToastMessageOptions];
+};
+
+/**
+ * **WangsVue - Toast**
+ *
+ * _Toast is used to display messages in an overlay._
+ *
+ * --- ---
+ * ![WangsVue](https://www.wangs.id/wp-content/uploads/2023/12/cropped-Logo_Wangsid-removebg-preview-192x192.png)
+ *
+ * @group Component
+ *
+ */
+declare class Toast extends ClassComponent<
+    ToastProps,
+    ToastSlots,
+    ToastEmits
+> {}
+
+declare module '@vue/runtime-core' {
+    interface GlobalComponents {
+        Toast: GlobalComponentConstructor<Toast>;
+    }
+}
+
+export default Toast;

package/components/toggleswitch/ToggleSwitch.vue.d.ts

@@ -0,0 +1,281 @@
+/**
+ *
+ * ToggleSwitch is used to select a boolean value.
+ *
+ * @module ToggleSwitch
+ *
+ */
+import { StyleValue } from 'vue';
+import { ComponentHooks } from '../basecomponent';
+import { PassThroughOptions } from '../passthrough';
+import {
+    ClassComponent,
+    GlobalComponentConstructor,
+    PassThrough,
+} from '../ts-helpers';
+
+export declare type ToggleSwitchPassThroughOptionType =
+    | ToggleSwitchPassThroughAttributes
+    | ((
+          options: ToggleSwitchPassThroughMethodOptions,
+      ) => ToggleSwitchPassThroughAttributes | string)
+    | string
+    | null
+    | undefined;
+
+/**
+ * Custom passthrough(pt) option method.
+ */
+export interface ToggleSwitchPassThroughMethodOptions {
+    /**
+     * Defines instance.
+     */
+    instance: any;
+
+    /**
+     * Defines valid properties.
+     */
+    props: ToggleSwitchProps;
+
+    /**
+     * Defines current options.
+     */
+    context: ToggleSwitchContext;
+
+    /**
+     * Defines valid attributes.
+     */
+    attrs: any;
+
+    /**
+     * Defines parent options.
+     */
+    parent: any;
+
+    /**
+     * Defines passthrough(pt) options in global config.
+     */
+    global: object | undefined;
+}
+
+/**
+ * Custom passthrough(pt) options.
+ * @see {@link ToggleSwitchProps.pt}
+ */
+export interface ToggleSwitchPassThroughOptions {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: ToggleSwitchPassThroughOptionType;
+
+    /**
+     * Used to pass attributes to the input's DOM element.
+     */
+    input?: ToggleSwitchPassThroughOptionType;
+
+    /**
+     * Used to pass attributes to the slider's DOM element.
+     */
+    slider?: ToggleSwitchPassThroughOptionType;
+
+    /**
+     * Used to manage all lifecycle hooks.
+     * @see {@link BaseComponent.ComponentHooks}
+     */
+    hooks?: ComponentHooks;
+}
+
+/**
+ * Custom passthrough attributes for each DOM elements
+ */
+export interface ToggleSwitchPassThroughAttributes {
+    [key: string]: any;
+}
+
+/**
+ * Defines valid properties in ToggleSwitch component.
+ */
+export interface ToggleSwitchProps {
+    /**
+     * Enables triple state mode where the value can be 'null', 'true', or 'false'.
+     *
+     * - null: not checked
+     * - true: checked
+     * - false: partially checked
+     *
+     * @defaultValue false
+     */
+    triState?: boolean;
+
+    /**
+     * Specifies whether a ToggleSwitch should be checked or not.
+     * @defaultValue false - when tristate = false
+     * @defaultValue null - when tristate = true
+     */
+    modelValue?: boolean | string | null | undefined;
+
+    /**
+     * Value in checked state.
+     * @defaultValue true
+     */
+    trueValue?: any;
+
+    /**
+     * Value in unchecked state.
+     * @defaultValue false
+     */
+    falseValue?: any;
+
+    /**
+     * A string that defines the name of the input field.
+     */
+    label?: string;
+
+    /**
+     * Tooltip info about the checkbox.
+     */
+    tooltip?: string;
+    /**
+     * Tooltip position.
+     *
+     * @default 'top'
+     */
+    tooltipPos?: 'top' | 'right' | 'left' | 'bottom';
+
+    /**
+     * When present, it specifies that the component should have invalid state style.
+     * @defaultValue false
+     */
+    invalid?: boolean | undefined;
+
+    /**
+     * When present, it specifies that the component should be disabled.
+     * @defaultValue false
+     */
+    disabled?: boolean | undefined;
+
+    /**
+     * When present, it specifies that an input field is read-only.
+     * @default false
+     */
+    readonly?: boolean | undefined;
+
+    /**
+     * Index of the element in tabbing order.
+     */
+    tabindex?: number | undefined;
+
+    /**
+     * Identifier of the underlying input element.
+     */
+    inputId?: string | undefined;
+
+    /**
+     * Style class of the input field.
+     */
+    inputClass?: string | object | undefined;
+
+    /**
+     * Inline style of the input field.
+     */
+    inputStyle?: StyleValue | undefined;
+
+    /**
+     * Establishes relationships between the component and label(s) where its value should be one or more element IDs.
+     */
+    ariaLabelledby?: string | undefined;
+
+    /**
+     * Establishes a string value that labels the component.
+     */
+    ariaLabel?: string | undefined;
+
+    /**
+     * Used to pass attributes to DOM elements inside the component.
+     * @type {ToggleSwitchPassThroughOptions}
+     */
+    pt?: PassThrough<ToggleSwitchPassThroughOptions>;
+
+    /**
+     * Used to configure passthrough(pt) options of the component.
+     * @type {PassThroughOptions}
+     */
+    ptOptions?: PassThroughOptions;
+
+    /**
+     * When enabled, it removes component related styles in the core.
+     * @defaultValue false
+     */
+    unstyled?: boolean;
+}
+
+/**
+ * Defines current options in ToggleSwitch component.
+ */
+export interface ToggleSwitchContext {
+    /**
+     * Current checked state of the item as a boolean.
+     * @defaultValue false
+     */
+    checked: boolean;
+
+    /**
+     * Current disabled state of the item as a boolean.
+     * @defaultValue false
+     */
+    disabled: boolean;
+}
+/**
+ * Defines valid emits in ToggleSwitch component.
+ */
+export type ToggleSwitchEmits = {
+    /**
+     * Emitted when the value changes.
+     * @param {boolean} value - New value.
+     */
+    'update:modelValue': [value: boolean];
+
+    /**
+     * Callback to invoke on value change.
+     * @param {Event} event - Browser event.
+     */
+    'change': [event: Event];
+
+    /**
+     * Callback to invoke when the component receives focus.
+     * @param {Event} event - Browser event.
+     */
+    'focus': [event: Event];
+
+    /**
+     * Callback to invoke when the component loses focus.
+     * @param {Event} event - Browser event.
+     */
+    'blur': [event: Event];
+};
+
+/**
+ * **PrimeVue - ToggleSwitch**
+ *
+ * _ToggleSwitch is used to select a boolean value._
+ *
+ * [Live Demo](https://fewangsit.github.io/wangsvue/toggle)
+ * --- ---
+ * ![WangsVue](https://www.wangs.id/wp-content/uploads/2023/12/cropped-Logo_Wangsid-removebg-preview-192x192.png)
+ *
+ * @group Component
+ *
+ */
+declare class ToggleSwitch extends ClassComponent<
+    ToggleSwitchProps,
+    unknown,
+    ToggleSwitchEmits
+> {}
+
+declare module 'vue' {
+    export interface GlobalComponents {
+        ToggleSwitch: GlobalComponentConstructor<ToggleSwitch>;
+    }
+}
+
+export default ToggleSwitch;