@synergy-design-system/metadata 1.0.0 → 3.0.1

package/data/layers/full/component/component:syn-dialog/components/dialog.ts

@@ -0,0 +1,13 @@
+/* eslint-disable */
+import SynDialog from './dialog.component.js';
+
+export * from './dialog.component.js';
+export default SynDialog;
+
+SynDialog.define('syn-dialog');
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'syn-dialog': SynDialog;
+  }
+}

package/data/layers/full/component/component:syn-dialog/react/SynDialogJSXElement.ts

@@ -0,0 +1,11 @@
+export type SynDialogJSXElement = SynCustomElement<
+  SynDialog,
+  [
+    ['syn-show', SynShowEvent],
+    ['syn-after-show', SynAfterShowEvent],
+    ['syn-hide', SynHideEvent],
+    ['syn-after-hide', SynAfterHideEvent],
+    ['syn-initial-focus', SynInitialFocusEvent],
+    ['syn-request-close', SynRequestCloseEvent],
+  ]
+>;

package/data/layers/full/component/component:syn-dialog/react/dialog.ts

@@ -0,0 +1,91 @@
+// ---------------------------------------------------------------------
+// 🔒 AUTOGENERATED @synergy-design-system/react wrappers for @synergy-design-system/components
+// Please do not edit this file directly!
+// It will get recreated when running pnpm build.
+// ---------------------------------------------------------------------
+import * as React from 'react';
+import { createComponent } from '@lit/react';
+import Component from '@synergy-design-system/components/components/dialog/dialog.component.js';
+
+import { type EventName } from '@lit/react';
+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 { SynInitialFocusEvent } from '@synergy-design-system/components';
+import type { SynRequestCloseEvent } from '@synergy-design-system/components';
+
+const tagName = 'syn-dialog';
+Component.define('syn-dialog');
+
+/**
+ * @summary Dialogs, sometimes called "modals", appear above the page and require the user's immediate attention.
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-dialog--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @dependency syn-icon-button
+ *
+ * @slot - The dialog's main content.
+ * @slot label - The dialog's label. Alternatively, you can use the `label` attribute.
+ * @slot header-actions - Optional actions to add to the header. Works best with `<syn-icon-button>`.
+ * @slot footer - The dialog's footer, usually one or more buttons representing various options.
+ *
+ * @event syn-show - Emitted when the dialog opens.
+ * @event syn-after-show - Emitted after the dialog opens and all animations are complete.
+ * @event syn-hide - Emitted when the dialog closes.
+ * @event syn-after-hide - Emitted after the dialog closes and all animations are complete.
+ * @event syn-initial-focus - Emitted when the dialog opens and is ready to receive focus. Calling
+ *   `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input.
+ * @event {{ source: 'close-button' | 'keyboard' | 'overlay' }} syn-request-close - Emitted when the user attempts to
+ *   close the dialog by clicking the close button, clicking the overlay, or pressing escape. Calling
+ *   `event.preventDefault()` will keep the dialog open. Avoid using this unless closing the dialog will result in
+ *   destructive behavior such as data loss.
+ *
+ * @csspart base - The component's base wrapper.
+ * @csspart overlay - The overlay that covers the screen behind the dialog.
+ * @csspart panel - The dialog's panel (where the dialog and its content are rendered).
+ * @csspart header - The dialog's header. This element wraps the title and header actions.
+ * @csspart header-actions - Optional actions to add to the header. Works best with `<syn-icon-button>`.
+ * @csspart title - The dialog's title.
+ * @csspart close-button - The close button, an `<syn-icon-button>`.
+ * @csspart close-button__base - The close button's exported `base` part.
+ * @csspart body - The dialog's body.
+ * @csspart footer - The dialog's footer.
+ *
+ * @cssproperty --width - The preferred width of the dialog. Note that the dialog will shrink to accommodate smaller screens.
+ * @cssproperty --header-spacing - The amount of padding to use for the header.
+ * @cssproperty --body-spacing - The amount of padding to use for the body.
+ * @cssproperty --footer-spacing - The amount of padding to use for the footer.
+ *
+ * @animation dialog.show - The animation to use when showing the dialog.
+ * @animation dialog.hide - The animation to use when hiding the dialog.
+ * @animation dialog.denyClose - The animation to use when a request to close the dialog is denied.
+ * @animation dialog.overlay.show - The animation to use when showing the dialog's overlay.
+ * @animation dialog.overlay.hide - The animation to use when hiding the dialog's overlay.
+ *
+ * @property modal - Exposes the internal modal utility that controls focus trapping. To temporarily disable focus
+ *   trapping and allow third-party modals spawned from an active Synergy modal, call `modal.activateExternal()` when
+ *   the third-party modal opens. Upon closing, call `modal.deactivateExternal()` to restore Synergy's focus trapping.
+ */
+export const SynDialog = createComponent({
+  displayName: 'SynDialog',
+  elementClass: Component,
+  events: {
+    onSynShow: 'syn-show' as EventName<SynShowEvent>,
+    onSynAfterShow: 'syn-after-show' as EventName<SynAfterShowEvent>,
+    onSynHide: 'syn-hide' as EventName<SynHideEvent>,
+    onSynAfterHide: 'syn-after-hide' as EventName<SynAfterHideEvent>,
+    onSynInitialFocus: 'syn-initial-focus' as EventName<SynInitialFocusEvent>,
+    onSynRequestClose: 'syn-request-close' as EventName<SynRequestCloseEvent>,
+  },
+  react: React,
+  tagName,
+});
+
+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 { SynInitialFocusEvent } from '@synergy-design-system/components';
+export type { SynRequestCloseEvent } from '@synergy-design-system/components';

package/data/layers/full/component/component:syn-dialog/vue/SynVueDialog.vue

@@ -0,0 +1,169 @@
+<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 Dialogs, sometimes called "modals", appear above the page and require the user's immediate attention.
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-dialog--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @dependency syn-icon-button
+ *
+ * @slot - The dialog's main content.
+ * @slot label - The dialog's label. Alternatively, you can use the `label` attribute.
+ * @slot header-actions - Optional actions to add to the header. Works best with `<syn-icon-button>`.
+ * @slot footer - The dialog's footer, usually one or more buttons representing various options.
+ *
+ * @event syn-show - Emitted when the dialog opens.
+ * @event syn-after-show - Emitted after the dialog opens and all animations are complete.
+ * @event syn-hide - Emitted when the dialog closes.
+ * @event syn-after-hide - Emitted after the dialog closes and all animations are complete.
+ * @event syn-initial-focus - Emitted when the dialog opens and is ready to receive focus. Calling
+ *   `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input.
+ * @event {{ source: 'close-button' | 'keyboard' | 'overlay' }} syn-request-close - Emitted when the user attempts to
+ *   close the dialog by clicking the close button, clicking the overlay, or pressing escape. Calling
+ *   `event.preventDefault()` will keep the dialog open. Avoid using this unless closing the dialog will result in
+ *   destructive behavior such as data loss.
+ *
+ * @csspart base - The component's base wrapper.
+ * @csspart overlay - The overlay that covers the screen behind the dialog.
+ * @csspart panel - The dialog's panel (where the dialog and its content are rendered).
+ * @csspart header - The dialog's header. This element wraps the title and header actions.
+ * @csspart header-actions - Optional actions to add to the header. Works best with `<syn-icon-button>`.
+ * @csspart title - The dialog's title.
+ * @csspart close-button - The close button, an `<syn-icon-button>`.
+ * @csspart close-button__base - The close button's exported `base` part.
+ * @csspart body - The dialog's body.
+ * @csspart footer - The dialog's footer.
+ *
+ * @cssproperty --width - The preferred width of the dialog. Note that the dialog will shrink to accommodate smaller screens.
+ * @cssproperty --header-spacing - The amount of padding to use for the header.
+ * @cssproperty --body-spacing - The amount of padding to use for the body.
+ * @cssproperty --footer-spacing - The amount of padding to use for the footer.
+ *
+ * @animation dialog.show - The animation to use when showing the dialog.
+ * @animation dialog.hide - The animation to use when hiding the dialog.
+ * @animation dialog.denyClose - The animation to use when a request to close the dialog is denied.
+ * @animation dialog.overlay.show - The animation to use when showing the dialog's overlay.
+ * @animation dialog.overlay.hide - The animation to use when hiding the dialog's overlay.
+ *
+ * @property modal - Exposes the internal modal utility that controls focus trapping. To temporarily disable focus
+ *   trapping and allow third-party modals spawned from an active Synergy modal, call `modal.activateExternal()` when
+ *   the third-party modal opens. Upon closing, call `modal.deactivateExternal()` to restore Synergy's focus trapping.
+ */
+import { computed, ref } from 'vue';
+import '@synergy-design-system/components/components/dialog/dialog.js';
+
+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 { SynInitialFocusEvent } from '@synergy-design-system/components';
+import type { SynRequestCloseEvent } from '@synergy-design-system/components';
+import type { SynDialog } from '@synergy-design-system/components';
+
+// DOM Reference to the element
+const nativeElement = ref<SynDialog>();
+
+defineExpose({
+  nativeElement,
+});
+
+// Map attributes
+const props = defineProps<{
+  /**
+* Indicates whether or not the dialog is open.
+* 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?: 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?: 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?: SynDialog['noHeader'];
+}>();
+
+// 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 dialog opens.
+   */
+  'syn-show': [e: SynShowEvent];
+
+  /**
+   * Emitted after the dialog opens and all animations are complete.
+   */
+  'syn-after-show': [e: SynAfterShowEvent];
+
+  /**
+   * Emitted when the dialog closes.
+   */
+  'syn-hide': [e: SynHideEvent];
+
+  /**
+   * Emitted after the dialog closes and all animations are complete.
+   */
+  'syn-after-hide': [e: SynAfterHideEvent];
+
+  /**
+   * Emitted when the dialog opens and is ready to receive focus.
+   * Calling `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input.
+   */
+  'syn-initial-focus': [e: SynInitialFocusEvent];
+
+  /**
+   * Emitted when the user attempts to close the dialog by clicking the close button, clicking the overlay, or pressing escape.
+   * Calling `event.preventDefault()` will keep the dialog open.
+   * Avoid using this unless closing the dialog will result in destructive behavior such as data loss.
+   */
+  'syn-request-close': [e: SynRequestCloseEvent];
+}>();
+</script>
+
+<script lang="ts">
+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 { SynInitialFocusEvent } from '@synergy-design-system/components';
+export type { SynRequestCloseEvent } from '@synergy-design-system/components';
+</script>
+
+<template>
+  <syn-dialog
+    @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-initial-focus="$emit('syn-initial-focus', $event)"
+    @syn-request-close="$emit('syn-request-close', $event)"
+    v-bind="visibleProps"
+    ref="nativeElement">
+    <slot></slot>
+  </syn-dialog>
+</template>

package/data/layers/full/component/component:syn-divider/angular/divider.component.ts

@@ -0,0 +1,55 @@
+// ---------------------------------------------------------------------
+// 🔒 AUTOGENERATED @synergy-design-system/angular wrappers for @synergy-design-system/components
+// Please do not edit this file directly!
+// It will get recreated when running pnpm build.
+// ---------------------------------------------------------------------
+import {
+  Component,
+  ElementRef,
+  NgZone,
+  Input,
+  Output,
+  EventEmitter,
+  AfterContentInit,
+} from '@angular/core';
+import type { SynDivider } from '@synergy-design-system/components';
+
+import '@synergy-design-system/components/components/divider/divider.js';
+
+/**
+ * @summary Dividers are used to visually separate or group elements.
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-divider--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @cssproperty --color - The color of the divider.
+ * @cssproperty --width - The width of the divider.
+ * @cssproperty --spacing - The spacing of the divider.
+ */
+@Component({
+  selector: 'syn-divider',
+  standalone: true,
+  template: '<ng-content></ng-content>',
+})
+export class SynDividerComponent {
+  public nativeElement: SynDivider;
+  private _ngZone: NgZone;
+
+  constructor(e: ElementRef, ngZone: NgZone) {
+    this.nativeElement = e.nativeElement;
+    this._ngZone = ngZone;
+  }
+
+  /**
+   * Draws the divider in a vertical orientation.
+   */
+  @Input()
+  set vertical(v: '' | SynDivider['vertical']) {
+    this._ngZone.runOutsideAngular(
+      () => (this.nativeElement.vertical = v === '' || v),
+    );
+  }
+  get vertical(): SynDivider['vertical'] {
+    return this.nativeElement.vertical;
+  }
+}

package/data/layers/full/component/component:syn-divider/components/divider.component.ts

@@ -0,0 +1,34 @@
+/* eslint-disable */
+import { property } from 'lit/decorators.js';
+import { watch } from '../../internal/watch.js';
+import componentStyles from '../../styles/component.styles.js';
+import SynergyElement from '../../internal/synergy-element.js';
+import styles from './divider.styles.js';
+import type { CSSResultGroup } from 'lit';
+
+/**
+ * @summary Dividers are used to visually separate or group elements.
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-divider--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @cssproperty --color - The color of the divider.
+ * @cssproperty --width - The width of the divider.
+ * @cssproperty --spacing - The spacing of the divider.
+ */
+export default class SynDivider extends SynergyElement {
+  static styles: CSSResultGroup = [componentStyles, styles];
+
+  /** Draws the divider in a vertical orientation. */
+  @property({ type: Boolean, reflect: true }) vertical = false;
+
+  connectedCallback() {
+    super.connectedCallback();
+    this.setAttribute('role', 'separator');
+  }
+
+  @watch('vertical')
+  handleVerticalChange() {
+    this.setAttribute('aria-orientation', this.vertical ? 'vertical' : 'horizontal');
+  }
+}

package/data/layers/full/component/component:syn-divider/components/divider.styles.ts

@@ -0,0 +1,22 @@
+import { css } from 'lit';
+
+export default css`
+  :host {
+    --color: var(--syn-panel-border-color);
+    --width: var(--syn-panel-border-width);
+    --spacing: var(--syn-spacing-medium);
+  }
+
+  :host(:not([vertical])) {
+    border-top: solid var(--width) var(--color);
+    display: block;
+    margin: var(--spacing) 0;
+  }
+
+  :host([vertical]) {
+    border-left: solid var(--width) var(--color);
+    display: inline-block;
+    height: 100%;
+    margin: 0 var(--spacing);
+  }
+`;

package/data/layers/full/component/component:syn-divider/components/divider.ts

@@ -0,0 +1,13 @@
+/* eslint-disable */
+import SynDivider from './divider.component.js';
+
+export * from './divider.component.js';
+export default SynDivider;
+
+SynDivider.define('syn-divider');
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'syn-divider': SynDivider;
+  }
+}

package/data/layers/full/component/component:syn-divider/react/SynDividerJSXElement.ts

@@ -0,0 +1 @@
+export type SynDividerJSXElement = SynCustomElement<SynDivider, []>;

package/data/layers/full/component/component:syn-divider/react/divider.ts

@@ -0,0 +1,29 @@
+// ---------------------------------------------------------------------
+// 🔒 AUTOGENERATED @synergy-design-system/react wrappers for @synergy-design-system/components
+// Please do not edit this file directly!
+// It will get recreated when running pnpm build.
+// ---------------------------------------------------------------------
+import * as React from 'react';
+import { createComponent } from '@lit/react';
+import Component from '@synergy-design-system/components/components/divider/divider.component.js';
+
+const tagName = 'syn-divider';
+Component.define('syn-divider');
+
+/**
+ * @summary Dividers are used to visually separate or group elements.
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-divider--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @cssproperty --color - The color of the divider.
+ * @cssproperty --width - The width of the divider.
+ * @cssproperty --spacing - The spacing of the divider.
+ */
+export const SynDivider = createComponent({
+  displayName: 'SynDivider',
+  elementClass: Component,
+  events: {},
+  react: React,
+  tagName,
+});

package/data/layers/full/component/component:syn-divider/vue/SynVueDivider.vue

@@ -0,0 +1,51 @@
+<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 Dividers are used to visually separate or group elements.
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-divider--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @cssproperty --color - The color of the divider.
+ * @cssproperty --width - The width of the divider.
+ * @cssproperty --spacing - The spacing of the divider.
+ */
+import { computed, ref } from 'vue';
+import '@synergy-design-system/components/components/divider/divider.js';
+
+import type { SynDivider } from '@synergy-design-system/components';
+
+// DOM Reference to the element
+const nativeElement = ref<SynDivider>();
+
+defineExpose({
+  nativeElement,
+});
+
+// Map attributes
+const props = defineProps<{
+  /**
+   * Draws the divider in a vertical orientation.
+   */
+  vertical?: SynDivider['vertical'];
+}>();
+
+// 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'),
+  ),
+);
+</script>
+
+<template>
+  <syn-divider v-bind="visibleProps" ref="nativeElement"> </syn-divider>
+</template>