@fewangsit/wangsvue-fats 1.0.0-alpha.21 → 1.0.0-alpha.23

package/components/dialogform/DialogForm.vue.d.ts

@@ -5,290 +5,290 @@ import { WangsIcons } from '../icon/Icon.vue.d';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
 export type DialogFormValue =
-  | string
-  | string[]
-  | number
-  | number[]
-  | boolean
-  | boolean[]
-  | Record<string, unknown>
-  | Record<string, unknown>[];
+    | string
+    | string[]
+    | number
+    | number[]
+    | boolean
+    | boolean[]
+    | Record<string, unknown>
+    | Record<string, unknown>[];
 
 /**
  * Generic form payload, able to receive types from outside
  */
 export type DialogFormPayload<
-  FormValuesType = Record<string, DialogFormValue>,
+    FormValuesType = Record<string, DialogFormValue>,
 > = {
-  stayAfterSubmit: boolean;
-  formValues: FormValuesType;
+    stayAfterSubmit: boolean;
+    formValues: FormValuesType;
 };
 
 export interface DialogFormLocaleConfig {
-  /**
-   * @example 'Cancel'
-   */
-  cancelBtnLabel?: string;
-
-  /**
-   * @example 'Clear Field'
-   */
-  clearBtnLabel?: string;
-
-  /**
-   * @example 'Stay after submit'
-   */
-  stayCheckboxLabel?: string;
-
-  /**
-   * @example 'Submit'
-   */
-  submitBtnLabel?: string;
-
-  /**
-   * Set the label for button expand sidebar right when it is expanded.
-   *
-   * @example 'Tutup <'
-   */
-  asideRightExpandedButtonLabel?: string;
-
-  /**
-   * Set the label for button expand sidebar right when it is collapsed.
-   *
-   * @example 'Lihat data yang ada >'
-   */
-  asideRightCollapsedButtonLabel?: string;
+    /**
+     * @example 'Cancel'
+     */
+    cancelBtnLabel?: string;
+
+    /**
+     * @example 'Clear Field'
+     */
+    clearBtnLabel?: string;
+
+    /**
+     * @example 'Stay after submit'
+     */
+    stayCheckboxLabel?: string;
+
+    /**
+     * @example 'Submit'
+     */
+    submitBtnLabel?: string;
+
+    /**
+     * Set the label for button expand sidebar right when it is expanded.
+     *
+     * @example 'Tutup <'
+     */
+    asideRightExpandedButtonLabel?: string;
+
+    /**
+     * Set the label for button expand sidebar right when it is collapsed.
+     *
+     * @example 'Lihat data yang ada >'
+     */
+    asideRightCollapsedButtonLabel?: string;
 }
 
 /**
  * Props for DialogForm component
  */
 export interface DialogFormProps extends FormProps {
-  /**
-   * The template for form buttons.
-   */
-  buttonsTemplate: ('clear' | 'submit' | 'cancel')[];
-
-  /**
-   * The dialog header.
-   */
-  header: string;
-
-  /**
-   * Value binding to show/hide the dialog.
-   */
-  visible: boolean;
-
-  /**
-   * With in pixel
-   *
-   * @default 260
-   */
-  asideRightWidth?: number;
-  class?: string | string[];
-
-  /**
-   * Custom button cancel label.
-   *
-   * @default - The default value from locale configuration {@link DialogFormLocaleConfig.cancelBtnLabel}
-   *
-   */
-  cancelBtnLabel?: string;
-
-  /**
-   * Custom button clear label.
-   *
-   * @default - The default value from locale configuration {@link DialogFormLocaleConfig.clearBtnLabel}
-   */
-  clearBtnLabel?: string;
-
-  /**
-   * Wether show the Close icon or not.
-   */
-  closable?: boolean;
-
-  /**
-   * Close dialog after form validated and submitted.
-   *
-   * @default true
-   */
-  closeOnSubmit?: boolean;
-
-  /**
-   * @deprecated
-   */
-  contentClass?: string | string[];
-
-  /**
-   * Show Date time on header.
-   */
-  dateHeader?: string;
-
-  /**
-   * Set the header icon left beside of the title.
-   */
-  headerIcon?: WangsIcons;
-
-  /**
-   * Sets the invalid state.
-   *
-   * @default false
-   */
-  invalid?: boolean;
-
-  /**
-   * Prevent form resets after submitted. Default is resetted.
-   *
-   * @default true
-   */
-  resetAfterSubmit?: boolean;
-
-  /**
-   * The severity of the dialog.
-   * The severity will determine the dialog icons and color scheme.
-   */
-  severity?: 'success' | 'danger' | 'primary';
-
-  /**
-   * Show or hide the checkbox 'Stay after submit.'
-   *
-   * @default true - if the action is submit.
-   * @default false - if the action is save.
-   */
-  showStayCheckbox?: boolean;
-
-  /**
-   * Custom label for stay checkbox.
-   *
-   * @default - The default value from locale configuration {@link DialogFormLocaleConfig.stayCheckboxLabel}
-   */
-  stayCheckboxLabel?: string;
-
-  /**
-   * Custom button submit label.
-   * @default - The default value from locale configuration {@link DialogFormLocaleConfig.submitBtnLabel}
-   */
-  submitBtnLabel?: string;
-
-  /**
-   * Define the invalid message to be shown on invalid state above the Form submit button.
-   *
-   * @default undefined
-   */
-  validatorMessage?: string;
-
-  /**
-   * Additional validation function.
-   * Within this this function, you need to set the invalid props value.
-   *
-   * If after executing this function the props invalid is true, the form will not be submitted.
-   * Otherwise, 'submit' event will be emitted.
-   *
-   * @param values - the Form values
-   */
-  validationFunction?: (values: GenericObject) => void | Promise<void>;
-
-  /**
-   * Set the dialog size.
-   *
-   * - small: 400px
-   * - medium: 500px
-   * - large: 572px
-   * - semi-xlarge: 600px
-   * - xlarge: 800px
-   *
-   * @default 'small';
-   */
-  width?: 'small' | 'medium' | 'large' | 'semi-xlarge' | 'xlarge';
+    /**
+     * The template for form buttons.
+     */
+    buttonsTemplate: ('clear' | 'submit' | 'cancel')[];
+
+    /**
+     * The dialog header.
+     */
+    header: string;
+
+    /**
+     * Value binding to show/hide the dialog.
+     */
+    visible: boolean;
+
+    /**
+     * With in pixel
+     *
+     * @default 260
+     */
+    asideRightWidth?: number;
+    class?: string | string[];
+
+    /**
+     * Custom button cancel label.
+     *
+     * @default - The default value from locale configuration {@link DialogFormLocaleConfig.cancelBtnLabel}
+     *
+     */
+    cancelBtnLabel?: string;
+
+    /**
+     * Custom button clear label.
+     *
+     * @default - The default value from locale configuration {@link DialogFormLocaleConfig.clearBtnLabel}
+     */
+    clearBtnLabel?: string;
+
+    /**
+     * Wether show the Close icon or not.
+     */
+    closable?: boolean;
+
+    /**
+     * Close dialog after form validated and submitted.
+     *
+     * @default true
+     */
+    closeOnSubmit?: boolean;
+
+    /**
+     * @deprecated
+     */
+    contentClass?: string | string[];
+
+    /**
+     * Show Date time on header.
+     */
+    dateHeader?: string;
+
+    /**
+     * Set the header icon left beside of the title.
+     */
+    headerIcon?: WangsIcons;
+
+    /**
+     * Sets the invalid state.
+     *
+     * @default false
+     */
+    invalid?: boolean;
+
+    /**
+     * Prevent form resets after submitted. Default is resetted.
+     *
+     * @default true
+     */
+    resetAfterSubmit?: boolean;
+
+    /**
+     * The severity of the dialog.
+     * The severity will determine the dialog icons and color scheme.
+     */
+    severity?: 'success' | 'danger' | 'primary';
+
+    /**
+     * Show or hide the checkbox 'Stay after submit.'
+     *
+     * @default true - if the action is submit.
+     * @default false - if the action is save.
+     */
+    showStayCheckbox?: boolean;
+
+    /**
+     * Custom label for stay checkbox.
+     *
+     * @default - The default value from locale configuration {@link DialogFormLocaleConfig.stayCheckboxLabel}
+     */
+    stayCheckboxLabel?: string;
+
+    /**
+     * Custom button submit label.
+     * @default - The default value from locale configuration {@link DialogFormLocaleConfig.submitBtnLabel}
+     */
+    submitBtnLabel?: string;
+
+    /**
+     * Define the invalid message to be shown on invalid state above the Form submit button.
+     *
+     * @default undefined
+     */
+    validatorMessage?: string;
+
+    /**
+     * Additional validation function.
+     * Within this this function, you need to set the invalid props value.
+     *
+     * If after executing this function the props invalid is true, the form will not be submitted.
+     * Otherwise, 'submit' event will be emitted.
+     *
+     * @param values - the Form values
+     */
+    validationFunction?: (values: GenericObject) => void | Promise<void>;
+
+    /**
+     * Set the dialog size.
+     *
+     * - small: 400px
+     * - medium: 500px
+     * - large: 572px
+     * - semi-xlarge: 600px
+     * - xlarge: 800px
+     *
+     * @default 'small';
+     */
+    width?: 'small' | 'medium' | 'large' | 'semi-xlarge' | 'xlarge';
 }
 
 export interface ConfirmSlots {
-  /**
-   * The Visible state.
-   */
-  visible: boolean;
-
-  /**
-   * Hide the confirm dialog.
-   */
-  hide: () => void;
-
-  /**
-   * The submit function to be called after confirmation.
-   */
-  submit: (submitFn: (value: FormPayload) => Promise<void> | void) => void;
+    /**
+     * The Visible state.
+     */
+    visible: boolean;
+
+    /**
+     * Hide the confirm dialog.
+     */
+    hide: () => void;
+
+    /**
+     * The submit function to be called after confirmation.
+     */
+    submit: (submitFn: (value: FormPayload) => Promise<void> | void) => void;
 }
 
 export interface ActionSlots {
-  /**
-   * The submit function to be called after confirmation.
-   */
-  submit: (submitFn: () => Promise<void> | void) => void;
+    /**
+     * The submit function to be called after confirmation.
+     */
+    submit: (submitFn: () => Promise<void> | void) => void;
 }
 
 /**
  * Slots for DialogForm component
  */
 export interface DialogFormSlots {
-  /**
-   * Slot for action buttons.
-   */
-  'actionButtons': Slot<ActionSlots>;
-
-  /**
-   * Slot for aside right expansion.
-   */
-  'aside-right': Slot;
-
-  /**
-   * Slot for dialog confirm.
-   */
-  'confirm': Slot<ConfirmSlots>;
-
-  /**
-   * The fields slot for the Dialogform. Here is where you can put your Dialogform fields.
-   */
-  'fields': Slot<{ formValues: GenericObject; key?: number }>;
-
-  /**
-   * Slot for dialog header.
-   */
-  'header': Slot;
+    /**
+     * Slot for action buttons.
+     */
+    'actionButtons': Slot<ActionSlots>;
+
+    /**
+     * Slot for aside right expansion.
+     */
+    'aside-right': Slot;
+
+    /**
+     * Slot for dialog confirm.
+     */
+    'confirm': Slot<ConfirmSlots>;
+
+    /**
+     * The fields slot for the Dialogform. Here is where you can put your Dialogform fields.
+     */
+    'fields': Slot<{ formValues: GenericObject; key?: number }>;
+
+    /**
+     * Slot for dialog header.
+     */
+    'header': Slot;
 }
 
 /**
  * Emits for DialogForm component
  */
 export type DialogFormEmits = {
-  /**
-   * Emits when 'Clear Field' button clicked.
-   */
-  'clear': [];
-
-  /**
-   * When dialog is closed by close button.
-   */
-  'close': [];
-
-  /**
-   * Callback to invoke when dialog is hidden.
-   */
-  'hide': [];
-
-  /**
-   * Callback to invoke when dialog is shown.
-   */
-  'show': [];
-
-  /**
-   * Emits when the form validation succes and props.invalid is 'false'.
-   */
-  'submit': [values: DialogFormPayload];
-
-  /**
-   * When dialog is closed.
-   */
-  'update:visible': [state: boolean];
+    /**
+     * Emits when 'Clear Field' button clicked.
+     */
+    'clear': [];
+
+    /**
+     * When dialog is closed by close button.
+     */
+    'close': [];
+
+    /**
+     * Callback to invoke when dialog is hidden.
+     */
+    'hide': [];
+
+    /**
+     * Callback to invoke when dialog is shown.
+     */
+    'show': [];
+
+    /**
+     * Emits when the form validation succes and props.invalid is 'false'.
+     */
+    'submit': [values: DialogFormPayload];
+
+    /**
+     * When dialog is closed.
+     */
+    'update:visible': [state: boolean];
 };
 
 /**
@@ -303,47 +303,47 @@ export type DialogFormEmits = {
  * @group components
  */
 declare class DialogForm extends ClassComponent<
-  DialogFormProps,
-  DialogFormSlots,
-  DialogFormEmits
+    DialogFormProps,
+    DialogFormSlots,
+    DialogFormEmits
 > {
-  /**
-   * Exposed function to clears the form fields.
-   */
-  clearField: () => void;
-
-  /**
-   * The ref of form element.
-   */
-  form: FormInstance;
-
-  /**
-   * Set initial values for all fields.
-   */
-  setValues: (values: GenericObject) => void;
-
-  /**
-   * Set value for specific field.
-   */
-  setFieldValue: <T extends string>(
-    field: T,
-    value: GenericObject[T],
-    shouldValidate?: boolean,
-  ) => void;
-
-  /**
-   * Set errors fields
-   * @param fields - {
-   *   name: 'This name already exists'
-   * }
-   */
-  setErrors(fields: GenericObject): void;
+    /**
+     * Exposed function to clears the form fields.
+     */
+    clearField: () => void;
+
+    /**
+     * The ref of form element.
+     */
+    form: FormInstance;
+
+    /**
+     * Set initial values for all fields.
+     */
+    setValues: (values: GenericObject) => void;
+
+    /**
+     * Set value for specific field.
+     */
+    setFieldValue: <T extends string>(
+        field: T,
+        value: GenericObject[T],
+        shouldValidate?: boolean,
+    ) => void;
+
+    /**
+     * Set errors fields
+     * @param fields - {
+     *   name: 'This name already exists'
+     * }
+     */
+    setErrors(fields: GenericObject): void;
 }
 
 declare module '@vue/runtime-core' {
-  interface GlobalComponents {
-    DialogForm: GlobalComponentConstructor<DialogForm>;
-  }
+    interface GlobalComponents {
+        DialogForm: GlobalComponentConstructor<DialogForm>;
+    }
 }
 
 export default DialogForm;