@synergy-design-system/vue 2.5.0 → 2.7.0

package/dist/components/SynVueDetails.vue.d.ts

@@ -10,24 +10,24 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   * You can toggle this attribute to show and hide the details, or you
   can use the `show()` and `hide()` methods and this attribute will reflect the details' open state.
    */
-    open?: boolean | undefined;
+    open?: SynDetails["open"];
     /**
   * The summary to show in the header.
   * If you need to display HTML, use the `summary` slot instead.
    */
-    summary?: string | undefined;
+    summary?: SynDetails["summary"];
     /**
   * Disables the details so it can't be toggled.
    */
-    disabled?: boolean | undefined;
+    disabled?: SynDetails["disabled"];
     /**
   * Draws the details as contained element.
    */
-    contained?: boolean | undefined;
+    contained?: SynDetails["contained"];
     /**
   * The details's size.
    */
-    size?: "medium" | "large" | undefined;
+    size?: SynDetails["size"];
 }>, {
     nativeElement: import("vue").Ref<SynDetails | undefined>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -41,24 +41,24 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   * You can toggle this attribute to show and hide the details, or you
   can use the `show()` and `hide()` methods and this attribute will reflect the details' open state.
    */
-    open?: boolean | undefined;
+    open?: SynDetails["open"];
     /**
   * The summary to show in the header.
   * If you need to display HTML, use the `summary` slot instead.
    */
-    summary?: string | undefined;
+    summary?: SynDetails["summary"];
     /**
   * Disables the details so it can't be toggled.
    */
-    disabled?: boolean | undefined;
+    disabled?: SynDetails["disabled"];
     /**
   * Draws the details as contained element.
    */
-    contained?: boolean | undefined;
+    contained?: SynDetails["contained"];
     /**
   * The details's size.
    */
-    size?: "medium" | "large" | undefined;
+    size?: SynDetails["size"];
 }>>> & {
     "onSyn-show"?: ((e: SynShowEvent) => any) | undefined;
     "onSyn-after-show"?: ((e: SynAfterShowEvent) => any) | undefined;

package/dist/components/SynVueDialog.vue.d.ts

@@ -12,20 +12,20 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   * You can toggle this attribute to show and hide the dialog, or you can
   use the `show()` and `hide()` methods and this attribute will reflect the dialog's open state.
    */
-    open?: boolean | undefined;
+    open?: SynDialog["open"];
     /**
   * The dialog's label as displayed in the header.
   * You should always include a relevant label even when using
   `no-header`, as it is required for proper accessibility.
   * If you need to display HTML, use the `label` slot instead.
    */
-    label?: string | undefined;
+    label?: SynDialog["label"];
     /**
   * Disables the header.
   * This will also remove the default close button, so please ensure you provide an easy,
   accessible way for users to dismiss the dialog.
    */
-    noHeader?: boolean | undefined;
+    noHeader?: SynDialog["noHeader"];
 }>, {
     nativeElement: import("vue").Ref<SynDialog | undefined>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -41,20 +41,20 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   * You can toggle this attribute to show and hide the dialog, or you can
   use the `show()` and `hide()` methods and this attribute will reflect the dialog's open state.
    */
-    open?: boolean | undefined;
+    open?: SynDialog["open"];
     /**
   * The dialog's label as displayed in the header.
   * You should always include a relevant label even when using
   `no-header`, as it is required for proper accessibility.
   * If you need to display HTML, use the `label` slot instead.
    */
-    label?: string | undefined;
+    label?: SynDialog["label"];
     /**
   * Disables the header.
   * This will also remove the default close button, so please ensure you provide an easy,
   accessible way for users to dismiss the dialog.
    */
-    noHeader?: boolean | undefined;
+    noHeader?: SynDialog["noHeader"];
 }>>> & {
     "onSyn-show"?: ((e: SynShowEvent) => any) | undefined;
     "onSyn-after-show"?: ((e: SynAfterShowEvent) => any) | undefined;

package/dist/components/SynVueDivider.vue.d.ts

@@ -4,14 +4,14 @@ declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<{
     /**
   * Draws the divider in a vertical orientation.
    */
-    vertical?: boolean | undefined;
+    vertical?: SynDivider["vertical"];
 }>, {
     nativeElement: import("vue").Ref<SynDivider | undefined>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<{
     /**
   * Draws the divider in a vertical orientation.
    */
-    vertical?: boolean | undefined;
+    vertical?: SynDivider["vertical"];
 }>>>, {}, {}>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;

package/dist/components/SynVueDrawer.vue.d.ts

@@ -12,30 +12,30 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   * You can toggle this attribute to show and hide the drawer, or you can
   use the `show()` and `hide()` methods and this attribute will reflect the drawer's open state.
    */
-    open?: boolean | undefined;
+    open?: SynDrawer["open"];
     /**
   * The drawer's label as displayed in the header.
   * You should always include a relevant label even when using
   `no-header`, as it is required for proper accessibility.
   * If you need to display HTML, use the `label` slot instead.
    */
-    label?: string | undefined;
+    label?: SynDrawer["label"];
     /**
   * The direction from which the drawer will open.
    */
-    placement?: "top" | "end" | "bottom" | "start" | undefined;
+    placement?: SynDrawer["placement"];
     /**
   * By default, the drawer slides out of its containing block (usually the viewport).
   * To make the drawer slide out of
   its parent element, set this attribute and add `position: relative` to the parent.
    */
-    contained?: boolean | undefined;
+    contained?: SynDrawer["contained"];
     /**
   * Removes the header.
   * This will also remove the default close button, so please ensure you provide an easy,
   accessible way for users to dismiss the drawer.
    */
-    noHeader?: boolean | undefined;
+    noHeader?: SynDrawer["noHeader"];
 }>, {
     nativeElement: import("vue").Ref<SynDrawer | undefined>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -51,30 +51,30 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   * You can toggle this attribute to show and hide the drawer, or you can
   use the `show()` and `hide()` methods and this attribute will reflect the drawer's open state.
    */
-    open?: boolean | undefined;
+    open?: SynDrawer["open"];
     /**
   * The drawer's label as displayed in the header.
   * You should always include a relevant label even when using
   `no-header`, as it is required for proper accessibility.
   * If you need to display HTML, use the `label` slot instead.
    */
-    label?: string | undefined;
+    label?: SynDrawer["label"];
     /**
   * The direction from which the drawer will open.
    */
-    placement?: "top" | "end" | "bottom" | "start" | undefined;
+    placement?: SynDrawer["placement"];
     /**
   * By default, the drawer slides out of its containing block (usually the viewport).
   * To make the drawer slide out of
   its parent element, set this attribute and add `position: relative` to the parent.
    */
-    contained?: boolean | undefined;
+    contained?: SynDrawer["contained"];
     /**
   * Removes the header.
   * This will also remove the default close button, so please ensure you provide an easy,
   accessible way for users to dismiss the drawer.
    */
-    noHeader?: boolean | undefined;
+    noHeader?: SynDrawer["noHeader"];
 }>>> & {
     "onSyn-show"?: ((e: SynShowEvent) => any) | undefined;
     "onSyn-after-show"?: ((e: SynAfterShowEvent) => any) | undefined;

package/dist/components/SynVueDropdown.vue.d.ts

@@ -10,42 +10,42 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   * You can toggle this attribute to show and hide the dropdown, or you
   can use the `show()` and `hide()` methods and this attribute will reflect the dropdown's open state.
    */
-    open?: boolean | undefined;
+    open?: SynDropdown["open"];
     /**
   * The preferred placement of the dropdown panel.
   * Note that the actual placement may vary as needed to keep the panel
   inside of the viewport.
    */
-    placement?: "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right" | "right-start" | "right-end" | "left" | "left-start" | "left-end" | undefined;
+    placement?: SynDropdown["placement"];
     /**
   * Disables the dropdown so the panel will not open.
    */
-    disabled?: boolean | undefined;
+    disabled?: SynDropdown["disabled"];
     /**
   * By default, the dropdown is closed when an item is selected.
   * This attribute will keep it open instead.
   * Useful for
   dropdowns that allow for multiple interactions.
    */
-    stayOpenOnSelect?: boolean | undefined;
+    stayOpenOnSelect?: SynDropdown["stayOpenOnSelect"];
     /**
   * The distance in pixels from which to offset the panel away from its trigger.
    */
-    distance?: number | undefined;
+    distance?: SynDropdown["distance"];
     /**
   * The distance in pixels from which to offset the panel along its trigger.
    */
-    skidding?: number | undefined;
+    skidding?: SynDropdown["skidding"];
     /**
   * Enable this option to prevent the panel from being clipped when the component is placed inside a container with
   `overflow: auto|scroll`.
   * Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.
    */
-    hoist?: boolean | undefined;
+    hoist?: SynDropdown["hoist"];
     /**
   * Syncs the popup width or height to that of the trigger element.
    */
-    sync?: SynDropdown['sync'];
+    sync?: SynDropdown["sync"];
 }>, {
     nativeElement: import("vue").Ref<SynDropdown | undefined>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -59,42 +59,42 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   * You can toggle this attribute to show and hide the dropdown, or you
   can use the `show()` and `hide()` methods and this attribute will reflect the dropdown's open state.
    */
-    open?: boolean | undefined;
+    open?: SynDropdown["open"];
     /**
   * The preferred placement of the dropdown panel.
   * Note that the actual placement may vary as needed to keep the panel
   inside of the viewport.
    */
-    placement?: "top" | "bottom" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right" | "right-start" | "right-end" | "left" | "left-start" | "left-end" | undefined;
+    placement?: SynDropdown["placement"];
     /**
   * Disables the dropdown so the panel will not open.
    */
-    disabled?: boolean | undefined;
+    disabled?: SynDropdown["disabled"];
     /**
   * By default, the dropdown is closed when an item is selected.
   * This attribute will keep it open instead.
   * Useful for
   dropdowns that allow for multiple interactions.
    */
-    stayOpenOnSelect?: boolean | undefined;
+    stayOpenOnSelect?: SynDropdown["stayOpenOnSelect"];
     /**
   * The distance in pixels from which to offset the panel away from its trigger.
    */
-    distance?: number | undefined;
+    distance?: SynDropdown["distance"];
     /**
   * The distance in pixels from which to offset the panel along its trigger.
    */
-    skidding?: number | undefined;
+    skidding?: SynDropdown["skidding"];
     /**
   * Enable this option to prevent the panel from being clipped when the component is placed inside a container with
   `overflow: auto|scroll`.
   * Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.
    */
-    hoist?: boolean | undefined;
+    hoist?: SynDropdown["hoist"];
     /**
   * Syncs the popup width or height to that of the trigger element.
    */
-    sync?: SynDropdown['sync'];
+    sync?: SynDropdown["sync"];
 }>>> & {
     "onSyn-show"?: ((e: SynShowEvent) => any) | undefined;
     "onSyn-after-show"?: ((e: SynAfterShowEvent) => any) | undefined;

package/dist/components/SynVueFile.vue.d.ts

@@ -12,11 +12,11 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   via its length property.
   [see MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#getting_information_on_selected_files)
    */
-    files?: FileList | null | undefined;
+    files?: SynFile["files"];
     /**
   * The name of the file control, submitted as a name/value pair with form data.
    */
-    name?: string | undefined;
+    name?: SynFile["name"];
     /**
   * The value of the file control contains a string that represents the path of the selected file.
   If multiple files are selected, the value represents the first file in the list.
@@ -24,46 +24,46 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   Beware that the only valid value when setting a file control is an empty string!
   [see MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#value)
    */
-    value?: string | undefined;
+    value?: SynFile["value"];
     /**
   * The file control's size.
    */
-    size?: "medium" | "large" | "small" | undefined;
+    size?: SynFile["size"];
     /**
   * The file control's label.
   * If you need to display HTML, use the `label` slot instead.
    */
-    label?: string | undefined;
+    label?: SynFile["label"];
     /**
   * The file control's help text.
   If you need to display HTML, use the `help-text` slot instead.
    */
-    helpText?: string | undefined;
+    helpText?: SynFile["helpText"];
     /**
   * Disables the file control.
    */
-    disabled?: boolean | undefined;
+    disabled?: SynFile["disabled"];
     /**
   * Draw the file control as a drop area
    */
-    droparea?: boolean | undefined;
+    droparea?: SynFile["droparea"];
     /**
   * Comma separated list of supported file types
   [see MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept)
    */
-    accept?: string | undefined;
+    accept?: SynFile["accept"];
     /**
   * Specifies the types of files that the server accepts.
   Can be set either to user or environment.
   Works only when not using a droparea!
   [see MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/capture)
    */
-    capture?: "user" | "environment" | undefined;
+    capture?: SynFile["capture"];
     /**
   * Indicates whether the user can select more than one file.
   [see MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#multiple)
    */
-    multiple?: boolean | undefined;
+    multiple?: SynFile["multiple"];
     /**
   * Indicates that the file control should let the user select directories instead of files.
   When a directory is selected, the directory and its entire hierarchy of contents are included
@@ -71,7 +71,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   Note: This is a non-standard attribute but is supported in the major browsers.
   [see MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/webkitdirectory)
    */
-    webkitdirectory?: boolean | undefined;
+    webkitdirectory?: SynFile["webkitdirectory"];
     /**
   * By default, form controls are associated with the nearest containing `<form>` element.
   This attribute allows you to place the form control outside of a form and associate it
@@ -79,19 +79,19 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   * The form must be in the same document
   or shadow root for this to work.
    */
-    form?: string | undefined;
+    form?: SynFile["form"];
     /**
   * Makes the input a required field.
    */
-    required?: boolean | undefined;
+    required?: SynFile["required"];
     /**
   * Suppress the value from being displayed in the file control
    */
-    hideValue?: boolean | undefined;
+    hideValue?: SynFile["hideValue"];
     /**
   * Support for two way data binding
    */
-    modelValue?: FileList | null | undefined;
+    modelValue?: SynFile["files"];
 }>, {
     nativeElement: import("vue").Ref<SynFile | undefined>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -108,11 +108,11 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   via its length property.
   [see MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#getting_information_on_selected_files)
    */
-    files?: FileList | null | undefined;
+    files?: SynFile["files"];
     /**
   * The name of the file control, submitted as a name/value pair with form data.
    */
-    name?: string | undefined;
+    name?: SynFile["name"];
     /**
   * The value of the file control contains a string that represents the path of the selected file.
   If multiple files are selected, the value represents the first file in the list.
@@ -120,46 +120,46 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   Beware that the only valid value when setting a file control is an empty string!
   [see MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#value)
    */
-    value?: string | undefined;
+    value?: SynFile["value"];
     /**
   * The file control's size.
    */
-    size?: "medium" | "large" | "small" | undefined;
+    size?: SynFile["size"];
     /**
   * The file control's label.
   * If you need to display HTML, use the `label` slot instead.
    */
-    label?: string | undefined;
+    label?: SynFile["label"];
     /**
   * The file control's help text.
   If you need to display HTML, use the `help-text` slot instead.
    */
-    helpText?: string | undefined;
+    helpText?: SynFile["helpText"];
     /**
   * Disables the file control.
    */
-    disabled?: boolean | undefined;
+    disabled?: SynFile["disabled"];
     /**
   * Draw the file control as a drop area
    */
-    droparea?: boolean | undefined;
+    droparea?: SynFile["droparea"];
     /**
   * Comma separated list of supported file types
   [see MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept)
    */
-    accept?: string | undefined;
+    accept?: SynFile["accept"];
     /**
   * Specifies the types of files that the server accepts.
   Can be set either to user or environment.
   Works only when not using a droparea!
   [see MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/capture)
    */
-    capture?: "user" | "environment" | undefined;
+    capture?: SynFile["capture"];
     /**
   * Indicates whether the user can select more than one file.
   [see MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#multiple)
    */
-    multiple?: boolean | undefined;
+    multiple?: SynFile["multiple"];
     /**
   * Indicates that the file control should let the user select directories instead of files.
   When a directory is selected, the directory and its entire hierarchy of contents are included
@@ -167,7 +167,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   Note: This is a non-standard attribute but is supported in the major browsers.
   [see MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/webkitdirectory)
    */
-    webkitdirectory?: boolean | undefined;
+    webkitdirectory?: SynFile["webkitdirectory"];
     /**
   * By default, form controls are associated with the nearest containing `<form>` element.
   This attribute allows you to place the form control outside of a form and associate it
@@ -175,19 +175,19 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   * The form must be in the same document
   or shadow root for this to work.
    */
-    form?: string | undefined;
+    form?: SynFile["form"];
     /**
   * Makes the input a required field.
    */
-    required?: boolean | undefined;
+    required?: SynFile["required"];
     /**
   * Suppress the value from being displayed in the file control
    */
-    hideValue?: boolean | undefined;
+    hideValue?: SynFile["hideValue"];
     /**
   * Support for two way data binding
    */
-    modelValue?: FileList | null | undefined;
+    modelValue?: SynFile["files"];
 }>>> & {
     "onSyn-blur"?: ((e: SynBlurEvent) => any) | undefined;
     "onSyn-focus"?: ((e: SynFocusEvent) => any) | undefined;

package/dist/components/SynVueHeader.vue.d.ts

@@ -8,7 +8,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   * The headers label.
   * If you need to display HTML, use the `label` slot instead.
    */
-    label?: string | undefined;
+    label?: SynHeader["label"];
     /**
   * Defines the current visibility and icon of the burger-menu icon.
   The menu button is added automatically if the component finds a syn-side-nav in non-rail mode.
@@ -17,7 +17,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   - open: The burger menu is visible and shows the close icon
   - closed: The burger menu is visible and shows the open icon
    */
-    burgerMenu?: "open" | "hidden" | "closed" | undefined;
+    burgerMenu?: SynHeader["burgerMenu"];
 }>, {
     nativeElement: import("vue").Ref<SynHeader | undefined>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -29,7 +29,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   * The headers label.
   * If you need to display HTML, use the `label` slot instead.
    */
-    label?: string | undefined;
+    label?: SynHeader["label"];
     /**
   * Defines the current visibility and icon of the burger-menu icon.
   The menu button is added automatically if the component finds a syn-side-nav in non-rail mode.
@@ -38,7 +38,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
   - open: The burger menu is visible and shows the close icon
   - closed: The burger menu is visible and shows the open icon
    */
-    burgerMenu?: "open" | "hidden" | "closed" | undefined;
+    burgerMenu?: SynHeader["burgerMenu"];
 }>>> & {
     "onSyn-burger-menu-closed"?: ((e: SynBurgerMenuClosedEvent) => any) | undefined;
     "onSyn-burger-menu-hidden"?: ((e: SynBurgerMenuHiddenEvent) => any) | undefined;

package/dist/components/SynVueIcon.vue.d.ts

@@ -7,23 +7,23 @@ declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<{
   * The name of the icon to draw.
   * Available names depend on the icon library being used.
    */
-    name?: SynIcon['name'];
+    name?: SynIcon["name"];
     /**
   * An external URL of an SVG file.
   * Be sure you trust the content you are including, as it will be executed as code and
   can result in XSS attacks.
    */
-    src?: SynIcon['src'];
+    src?: SynIcon["src"];
     /**
   * An alternate description to use for assistive devices.
   * If omitted, the icon will be considered presentational and
   ignored by assistive devices.
    */
-    label?: string | undefined;
+    label?: SynIcon["label"];
     /**
   * The name of a registered custom icon library.
    */
-    library?: string | undefined;
+    library?: SynIcon["library"];
 }>, {
     nativeElement: import("vue").Ref<SynIcon | undefined>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -34,23 +34,23 @@ declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<{
   * The name of the icon to draw.
   * Available names depend on the icon library being used.
    */
-    name?: SynIcon['name'];
+    name?: SynIcon["name"];
     /**
   * An external URL of an SVG file.
   * Be sure you trust the content you are including, as it will be executed as code and
   can result in XSS attacks.
    */
-    src?: SynIcon['src'];
+    src?: SynIcon["src"];
     /**
   * An alternate description to use for assistive devices.
   * If omitted, the icon will be considered presentational and
   ignored by assistive devices.
    */
-    label?: string | undefined;
+    label?: SynIcon["label"];
     /**
   * The name of a registered custom icon library.
    */
-    library?: string | undefined;
+    library?: SynIcon["library"];
 }>>> & {
     "onSyn-error"?: ((e: SynErrorEvent) => any) | undefined;
     "onSyn-load"?: ((e: SynLoadEvent) => any) | undefined;