@synergy-design-system/vue 2.7.2 → 2.8.0

package/src/components/SynVueCheckbox.vue

@@ -34,9 +34,12 @@
 import { computed, ref } from 'vue';
 import '@synergy-design-system/components/components/checkbox/checkbox.js';
 
-import type {
-  SynBlurEvent, SynChangeEvent, SynCheckbox, SynFocusEvent, SynInputEvent, SynInvalidEvent,
-} from '@synergy-design-system/components';
+import type { SynBlurEvent } from '@synergy-design-system/components';
+import type { SynChangeEvent } from '@synergy-design-system/components';
+import type { SynFocusEvent } from '@synergy-design-system/components';
+import type { SynInputEvent } from '@synergy-design-system/components';
+import type { SynInvalidEvent } from '@synergy-design-system/components';
+import type { SynCheckbox } from '@synergy-design-system/components';
 
 // DOM Reference to the element
 const nativeElement = ref<SynCheckbox>();
@@ -47,39 +50,39 @@ defineExpose({
 
 // Map attributes
 const props = defineProps<{
-  'title'?: SynCheckbox['title'];
+  title?: SynCheckbox['title'];
 
   /**
-* The name of the checkbox, submitted as a name/value pair with form data.
- */
-  'name'?: SynCheckbox['name'];
+   * The name of the checkbox, submitted as a name/value pair with form data.
+   */
+  name?: SynCheckbox['name'];
 
   /**
-* The current value of the checkbox, submitted as a name/value pair with form data.
- */
-  'value'?: SynCheckbox['value'];
+   * The current value of the checkbox, submitted as a name/value pair with form data.
+   */
+  value?: SynCheckbox['value'];
 
   /**
-* The checkbox's size.
- */
-  'size'?: SynCheckbox['size'];
+   * The checkbox's size.
+   */
+  size?: SynCheckbox['size'];
 
   /**
-* Disables the checkbox.
- */
-  'disabled'?: SynCheckbox['disabled'];
+   * Disables the checkbox.
+   */
+  disabled?: SynCheckbox['disabled'];
 
   /**
-* Draws the checkbox in a checked state.
- */
-  'checked'?: SynCheckbox['checked'];
+   * Draws the checkbox in a checked state.
+   */
+  checked?: SynCheckbox['checked'];
 
   /**
 * Draws the checkbox in an indeterminate state.
 * This is usually applied to checkboxes that represents a "select
 all/none" behavior when associated checkboxes have a mix of checked and unchecked states.
  */
-  'indeterminate'?: SynCheckbox['indeterminate'];
+  indeterminate?: SynCheckbox['indeterminate'];
 
   /**
 * By default, form controls are associated with the nearest containing `<form>` element.
@@ -88,22 +91,22 @@ to place the form control outside of a form and associate it with the form that
 * The form must be in
 the same document or shadow root for this to work.
  */
-  'form'?: SynCheckbox['form'];
+  form?: SynCheckbox['form'];
 
   /**
-* Makes the checkbox a required field.
- */
-  'required'?: SynCheckbox['required'];
+   * Makes the checkbox a required field.
+   */
+  required?: SynCheckbox['required'];
 
   /**
-* The checkbox's help text.
-* If you need to display HTML, use the `help-text` slot instead.
- */
-  'helpText'?: SynCheckbox['helpText'];
+   * The checkbox's help text.
+   * If you need to display HTML, use the `help-text` slot instead.
+   */
+  helpText?: SynCheckbox['helpText'];
 
   /**
-* Support for two way data binding
- */
+   * Support for two way data binding
+   */
   modelValue?: SynCheckbox['checked'];
 }>();
 
@@ -111,42 +114,42 @@ the same document or shadow root for this to work.
 // This is needed because :param="param" also adds an empty attribute
 // when using web-components, which breaks optional arguments like size in SynInput
 // @see https://github.com/vuejs/core/issues/5190#issuecomment-1003112498
-const visibleProps = computed(() => Object.fromEntries(
-  Object
-    .entries(props)
-    .filter(([, value]) => typeof value !== 'undefined'),
-));
+const visibleProps = computed(() =>
+  Object.fromEntries(
+    Object.entries(props).filter(([, value]) => typeof value !== 'undefined'),
+  ),
+);
 
 // Map events
 defineEmits<{
   /**
-* Emitted when the checkbox loses focus.
- */
+   * Emitted when the checkbox loses focus.
+   */
   'syn-blur': [e: SynBlurEvent];
 
   /**
-* Emitted when the checked state changes.
- */
+   * Emitted when the checked state changes.
+   */
   'syn-change': [e: SynChangeEvent];
 
   /**
-* Emitted when the checkbox gains focus.
- */
+   * Emitted when the checkbox gains focus.
+   */
   'syn-focus': [e: SynFocusEvent];
 
   /**
-* Emitted when the checkbox receives input.
- */
+   * Emitted when the checkbox receives input.
+   */
   'syn-input': [e: SynInputEvent];
 
   /**
-* Emitted when the form control has been checked for validity and its constraints aren't satisfied.
- */
+   * Emitted when the form control has been checked for validity and its constraints aren't satisfied.
+   */
   'syn-invalid': [e: SynInvalidEvent];
 
   /**
-* Support for two way data binding
- */
+   * Support for two way data binding
+   */
   'update:modelValue': [newValue: SynCheckbox['checked']];
 }>();
 </script>
@@ -161,15 +164,23 @@ export type { SynInvalidEvent } from '@synergy-design-system/components';
 
 <template>
   <syn-checkbox
-    v-bind="visibleProps"
-    ref="nativeElement"
-    :checked="typeof props.modelValue !== 'undefined' ? props.modelValue : typeof props.checked !== 'undefined' ? props.checked : undefined"
     @syn-blur="$emit('syn-blur', $event)"
     @syn-change="$emit('syn-change', $event)"
     @syn-focus="$emit('syn-focus', $event)"
-    @syn-input="$emit('update:modelValue', $event.target.checked); $emit('syn-input', $event)"
+    @syn-input="
+      $emit('update:modelValue', $event.target.checked);
+      $emit('syn-input', $event);
+    "
     @syn-invalid="$emit('syn-invalid', $event)"
-  >
-    <slot />
+    :checked="
+      typeof props.modelValue !== 'undefined'
+        ? props.modelValue
+        : typeof props.checked !== 'undefined'
+          ? props.checked
+          : undefined
+    "
+    v-bind="visibleProps"
+    ref="nativeElement">
+    <slot></slot>
   </syn-checkbox>
 </template>

package/src/components/SynVueCombobox.vue

@@ -0,0 +1,295 @@
+<script setup lang="ts">
+// ---------------------------------------------------------------------
+// 🔒 AUTOGENERATED @synergy-design-system/vue wrappers for @synergy-design-system/components
+// Please do not edit this file directly!
+// It will get recreated when running pnpm build.
+// ---------------------------------------------------------------------
+
+/**
+ * @summary Comboboxes allow you to choose items from a menu of predefined options.
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-combobox--docs
+ * @status stable
+ *
+ * @dependency syn-icon
+ * @dependency syn-popup
+ *
+ * @slot - The listbox options. Must be `<syn-option>` elements.
+ *    You can use `<syn-optgroup>`'s to group items visually.
+ * @slot label - The combobox's label. Alternatively, you can use the `label` attribute.
+ * @slot prefix - Used to prepend a presentational icon or similar element to the combobox.
+ * @slot suffix - Used to append a presentational icon or similar element to the combobox.
+ * @slot clear-icon - An icon to use in lieu of the default clear icon.
+ * @slot expand-icon - The icon to show when the control is expanded and collapsed.
+ *    Rotates on open and close.
+ * @slot help-text - Text that describes how to use the combobox.
+ *    Alternatively, you can use the `help-text` attribute.
+ *
+ * @event syn-change - Emitted when the control's value changes.
+ * @event syn-clear - Emitted when the control's value is cleared.
+ * @event syn-input - Emitted when the control receives input.
+ * @event syn-focus - Emitted when the control gains focus.
+ * @event syn-blur - Emitted when the control loses focus.
+ * @event syn-show - Emitted when the combobox's menu opens.
+ * @event syn-after-show - Emitted after the combobox's menu opens and all animations are complete.
+ * @event syn-hide - Emitted when the combobox's menu closes.
+ * @event syn-after-hide - Emitted after the combobox's menu closes and all animations are complete.
+ * @event syn-invalid - Emitted when the form control has been checked for validity
+ *    and its constraints aren't satisfied.
+ * @event syn-error - Emitted when the combobox menu fails to open.
+ *
+ * @csspart form-control - The form control that wraps the label, combobox, and help text.
+ * @csspart form-control-label - The label's wrapper.
+ * @csspart form-control-input - The combobox's wrapper.
+ * @csspart form-control-help-text - The help text's wrapper.
+ * @csspart combobox - The container the wraps the prefix, combobox, clear icon, and expand button.
+ * @csspart prefix - The container that wraps the prefix slot.
+ * @csspart suffix - The container that wraps the suffix slot.
+ * @csspart display-input - The element that displays the selected option's label,
+ *     an `<input>` element.
+ * @csspart listbox - The listbox container where the options are slotted
+ *   and the filtered options list exists.
+ * @csspart filtered-listbox - The container that wraps the filtered options.
+ * @csspart clear-button - The clear button.
+ * @csspart expand-icon - The container that wraps the expand icon.
+ *
+ * @animation combobox.show - The animation to use when showing the combobox.
+ * @animation combobox.hide - The animation to use when hiding the combobox.
+ */
+import { computed, ref } from 'vue';
+import '@synergy-design-system/components/components/combobox/combobox.js';
+
+import type { SynChangeEvent } from '@synergy-design-system/components';
+import type { SynClearEvent } from '@synergy-design-system/components';
+import type { SynInputEvent } from '@synergy-design-system/components';
+import type { SynFocusEvent } from '@synergy-design-system/components';
+import type { SynBlurEvent } from '@synergy-design-system/components';
+import type { SynShowEvent } from '@synergy-design-system/components';
+import type { SynAfterShowEvent } from '@synergy-design-system/components';
+import type { SynHideEvent } from '@synergy-design-system/components';
+import type { SynAfterHideEvent } from '@synergy-design-system/components';
+import type { SynInvalidEvent } from '@synergy-design-system/components';
+import type { SynErrorEvent } from '@synergy-design-system/components';
+import type { SynCombobox } from '@synergy-design-system/components';
+
+// DOM Reference to the element
+const nativeElement = ref<SynCombobox>();
+
+defineExpose({
+  nativeElement,
+});
+
+// Map attributes
+const props = defineProps<{
+  /**
+   * The name of the combobox, submitted as a name/value pair with form data.
+   */
+  name?: SynCombobox['name'];
+
+  /**
+   * The current value of the combobox, submitted as a name/value pair with form data.
+   */
+  value?: SynCombobox['value'];
+
+  /**
+   * The combobox's size.
+   */
+  size?: SynCombobox['size'];
+
+  /**
+   * Placeholder text to show as a hint when the combobox is empty.
+   */
+  placeholder?: SynCombobox['placeholder'];
+
+  /**
+   * Disables the combobox control.
+   */
+  disabled?: SynCombobox['disabled'];
+
+  /**
+   * Adds a clear button when the combobox is not empty.
+   */
+  clearable?: SynCombobox['clearable'];
+
+  /**
+* Indicates whether or not the combobox is open.
+You can toggle this attribute to show and hide the listbox, or you can use the `show()`
+and `hide()` methods and this attribute will reflect the combobox's open state.
+ */
+  open?: SynCombobox['open'];
+
+  /**
+* Enable this option to prevent the listbox 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?: SynCombobox['hoist'];
+
+  /**
+   * The combobox's label.
+   * If you need to display HTML, use the `label` slot instead.
+   */
+  label?: SynCombobox['label'];
+
+  /**
+* The preferred placement of the combobox's menu.
+Note that the actual placement may vary as needed to keep the listbox inside of the viewport.
+ */
+  placement?: SynCombobox['placement'];
+
+  /**
+   * The combobox's help text.
+   * If you need to display HTML, use the `help-text` slot instead.
+   */
+  helpText?: SynCombobox['helpText'];
+
+  /**
+* 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
+with the form that has this `id`.
+The form must be in the same document or shadow root for this to work.
+ */
+  form?: SynCombobox['form'];
+
+  /**
+   * The combobox's required attribute.
+   */
+  required?: SynCombobox['required'];
+
+  /**
+* A function that customizes the rendered option.
+* The first argument is the option, the second
+is the query string, which is typed into the combobox.
+The function should return either a Lit TemplateResult or a string containing trusted HTML
+to render in the shown list of filtered options.
+If the query string should be highlighted use the `highlightOptionRenderer` function.
+ */
+  getOption?: SynCombobox['getOption'];
+
+  /**
+* A function used to filter options in the combobox component.
+The default filter method is a case- and diacritic-insensitive string comparison.
+ */
+  filter?: SynCombobox['filter'];
+
+  /**
+   * Support for two way data binding
+   */
+  modelValue?: SynCombobox['value'];
+}>();
+
+// Make sure prop binding only forwards the props that are actually there.
+// This is needed because :param="param" also adds an empty attribute
+// when using web-components, which breaks optional arguments like size in SynInput
+// @see https://github.com/vuejs/core/issues/5190#issuecomment-1003112498
+const visibleProps = computed(() =>
+  Object.fromEntries(
+    Object.entries(props).filter(([, value]) => typeof value !== 'undefined'),
+  ),
+);
+
+// Map events
+defineEmits<{
+  /**
+   * Emitted when the control's value changes.
+   */
+  'syn-change': [e: SynChangeEvent];
+
+  /**
+   * Emitted when the control's value is cleared.
+   */
+  'syn-clear': [e: SynClearEvent];
+
+  /**
+   * Emitted when the control receives input.
+   */
+  'syn-input': [e: SynInputEvent];
+
+  /**
+   * Emitted when the control gains focus.
+   */
+  'syn-focus': [e: SynFocusEvent];
+
+  /**
+   * Emitted when the control loses focus.
+   */
+  'syn-blur': [e: SynBlurEvent];
+
+  /**
+   * Emitted when the combobox's menu opens.
+   */
+  'syn-show': [e: SynShowEvent];
+
+  /**
+   * Emitted after the combobox's menu opens and all animations are complete.
+   */
+  'syn-after-show': [e: SynAfterShowEvent];
+
+  /**
+   * Emitted when the combobox's menu closes.
+   */
+  'syn-hide': [e: SynHideEvent];
+
+  /**
+   * Emitted after the combobox's menu closes and all animations are complete.
+   */
+  'syn-after-hide': [e: SynAfterHideEvent];
+
+  /**
+   * Emitted when the form control has been checked for validity and its constraints aren't satisfied.
+   */
+  'syn-invalid': [e: SynInvalidEvent];
+
+  /**
+   * Emitted when the combobox menu fails to open.
+   */
+  'syn-error': [e: SynErrorEvent];
+
+  /**
+   * Support for two way data binding
+   */
+  'update:modelValue': [newValue: SynCombobox['value']];
+}>();
+</script>
+
+<script lang="ts">
+export type { SynChangeEvent } from '@synergy-design-system/components';
+export type { SynClearEvent } from '@synergy-design-system/components';
+export type { SynInputEvent } from '@synergy-design-system/components';
+export type { SynFocusEvent } from '@synergy-design-system/components';
+export type { SynBlurEvent } from '@synergy-design-system/components';
+export type { SynShowEvent } from '@synergy-design-system/components';
+export type { SynAfterShowEvent } from '@synergy-design-system/components';
+export type { SynHideEvent } from '@synergy-design-system/components';
+export type { SynAfterHideEvent } from '@synergy-design-system/components';
+export type { SynInvalidEvent } from '@synergy-design-system/components';
+export type { SynErrorEvent } from '@synergy-design-system/components';
+</script>
+
+<template>
+  <syn-combobox
+    @syn-change="$emit('syn-change', $event)"
+    @syn-clear="$emit('syn-clear', $event)"
+    @syn-input="
+      $emit('update:modelValue', $event.target.value);
+      $emit('syn-input', $event);
+    "
+    @syn-focus="$emit('syn-focus', $event)"
+    @syn-blur="$emit('syn-blur', $event)"
+    @syn-show="$emit('syn-show', $event)"
+    @syn-after-show="$emit('syn-after-show', $event)"
+    @syn-hide="$emit('syn-hide', $event)"
+    @syn-after-hide="$emit('syn-after-hide', $event)"
+    @syn-invalid="$emit('syn-invalid', $event)"
+    @syn-error="$emit('syn-error', $event)"
+    :value="
+      typeof props.modelValue !== 'undefined'
+        ? props.modelValue
+        : typeof props.value !== 'undefined'
+          ? props.value
+          : undefined
+    "
+    v-bind="visibleProps"
+    ref="nativeElement">
+    <slot></slot>
+  </syn-combobox>
+</template>

package/src/components/SynVueDetails.vue

@@ -35,9 +35,11 @@
 import { computed, ref } from 'vue';
 import '@synergy-design-system/components/components/details/details.js';
 
-import type {
-  SynAfterHideEvent, SynAfterShowEvent, SynDetails, SynHideEvent, SynShowEvent,
-} from '@synergy-design-system/components';
+import type { SynShowEvent } from '@synergy-design-system/components';
+import type { SynAfterShowEvent } from '@synergy-design-system/components';
+import type { SynHideEvent } from '@synergy-design-system/components';
+import type { SynAfterHideEvent } from '@synergy-design-system/components';
+import type { SynDetails } from '@synergy-design-system/components';
 
 // DOM Reference to the element
 const nativeElement = ref<SynDetails>();
@@ -53,60 +55,60 @@ const props = defineProps<{
 * 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'?: SynDetails['open'];
+  open?: SynDetails['open'];
 
   /**
-* The summary to show in the header.
-* If you need to display HTML, use the `summary` slot instead.
- */
-  'summary'?: SynDetails['summary'];
+   * The summary to show in the header.
+   * If you need to display HTML, use the `summary` slot instead.
+   */
+  summary?: SynDetails['summary'];
 
   /**
-* Disables the details so it can't be toggled.
- */
-  'disabled'?: SynDetails['disabled'];
+   * Disables the details so it can't be toggled.
+   */
+  disabled?: SynDetails['disabled'];
 
   /**
-* Draws the details as contained element.
- */
-  'contained'?: SynDetails['contained'];
+   * Draws the details as contained element.
+   */
+  contained?: SynDetails['contained'];
 
   /**
-* The details's size.
- */
-  'size'?: SynDetails['size'];
+   * The details's size.
+   */
+  size?: SynDetails['size'];
 }>();
 
 // Make sure prop binding only forwards the props that are actually there.
 // This is needed because :param="param" also adds an empty attribute
 // when using web-components, which breaks optional arguments like size in SynInput
 // @see https://github.com/vuejs/core/issues/5190#issuecomment-1003112498
-const visibleProps = computed(() => Object.fromEntries(
-  Object
-    .entries(props)
-    .filter(([, value]) => typeof value !== 'undefined'),
-));
+const visibleProps = computed(() =>
+  Object.fromEntries(
+    Object.entries(props).filter(([, value]) => typeof value !== 'undefined'),
+  ),
+);
 
 // Map events
 defineEmits<{
   /**
-* Emitted when the details opens.
- */
+   * Emitted when the details opens.
+   */
   'syn-show': [e: SynShowEvent];
 
   /**
-* Emitted after the details opens and all animations are complete.
- */
+   * Emitted after the details opens and all animations are complete.
+   */
   'syn-after-show': [e: SynAfterShowEvent];
 
   /**
-* Emitted when the details closes.
- */
+   * Emitted when the details closes.
+   */
   'syn-hide': [e: SynHideEvent];
 
   /**
-* Emitted after the details closes and all animations are complete.
- */
+   * Emitted after the details closes and all animations are complete.
+   */
   'syn-after-hide': [e: SynAfterHideEvent];
 }>();
 </script>
@@ -120,14 +122,12 @@ export type { SynAfterHideEvent } from '@synergy-design-system/components';
 
 <template>
   <syn-details
-    v-bind="visibleProps"
-    ref="nativeElement"
     @syn-show="$emit('syn-show', $event)"
     @syn-after-show="$emit('syn-after-show', $event)"
-
     @syn-hide="$emit('syn-hide', $event)"
     @syn-after-hide="$emit('syn-after-hide', $event)"
-  >
-    <slot />
+    v-bind="visibleProps"
+    ref="nativeElement">
+    <slot></slot>
   </syn-details>
 </template>