@synergy-design-system/metadata 1.0.0 → 3.0.0

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

@@ -0,0 +1,125 @@
+/* eslint-disable */
+import { classMap } from 'lit/directives/class-map.js';
+import { html } from 'lit';
+import { LocalizeController } from '../../utilities/localize.js';
+import { property, query } 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 SynIconButton from '../icon-button/icon-button.component.js';
+import styles from './tab.styles.js';
+import customStyles from './tab.custom.styles.js';
+import type { CSSResultGroup } from 'lit';
+
+let id = 0;
+
+/**
+ * @summary Tabs are used inside [tab groups](/components/tab-group) to represent and activate [tab panels](/components/tab-panel).
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-tab--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @dependency syn-icon-button
+ *
+ * @slot - The tab's label.
+ *
+ * @event syn-close - Emitted when the tab is closable and the close button is activated.
+ *
+ * @csspart base - The component's base wrapper.
+ * @csspart close-button - The close button, an `<syn-icon-button>`.
+ * @csspart close-button__base - The close button's exported `base` part.
+ */
+export default class SynTab extends SynergyElement {
+  static styles: CSSResultGroup = [componentStyles, styles, customStyles];
+  static dependencies = { 'syn-icon-button': SynIconButton };
+
+  private readonly localize = new LocalizeController(this);
+
+  private readonly attrId = ++id;
+  private readonly componentId = `syn-tab-${this.attrId}`;
+
+  @query('.tab') tab: HTMLElement;
+
+  /** The name of the tab panel this tab is associated with. The panel must be located in the same tab group. */
+  @property({ reflect: true }) panel = '';
+
+  /** Draws the tab in an active state. */
+  @property({ type: Boolean, reflect: true }) active = false;
+
+  /** Makes the tab closable and shows a close button. */
+  @property({ type: Boolean, reflect: true }) closable = false;
+
+  /** Disables the tab and prevents selection. */
+  @property({ type: Boolean, reflect: true }) disabled = false;
+
+  /**
+   * @internal
+   * Need to wrap in a `@property()` otherwise CustomElement throws a "The result must not have attributes" runtime error.
+   */
+  @property({ type: Number, reflect: true }) tabIndex = 0;
+
+  connectedCallback() {
+    super.connectedCallback();
+    this.setAttribute('role', 'tab');
+  }
+
+  private handleCloseClick(event: Event) {
+    event.stopPropagation();
+    this.emit('syn-close');
+  }
+
+  @watch('active')
+  handleActiveChange() {
+    this.setAttribute('aria-selected', this.active ? 'true' : 'false');
+  }
+
+  @watch('disabled')
+  handleDisabledChange() {
+    this.setAttribute('aria-disabled', this.disabled ? 'true' : 'false');
+
+    if (this.disabled && !this.active) {
+      this.tabIndex = -1;
+    } else {
+      this.tabIndex = 0;
+    }
+  }
+
+  render() {
+    // If the user didn't provide an ID, we'll set one so we can link tabs and tab panels with aria labels
+    this.id = this.id.length > 0 ? this.id : this.componentId;
+
+    return html`
+      <div
+        part="base"
+        class=${classMap({
+          tab: true,
+          'tab--active': this.active,
+          'tab--closable': this.closable,
+          'tab--disabled': this.disabled
+        })}
+      >
+        <slot></slot>
+        ${this.closable
+          ? html`
+              <syn-icon-button
+                part="close-button"
+                exportparts="base:close-button__base"
+                name="x-lg"
+                library="system"
+                label=${this.localize.term('close')}
+                class="tab__close-button"
+                @click=${this.handleCloseClick}
+                tabindex="-1"
+              ></syn-icon-button>
+            `
+          : ''}
+      </div>
+    `;
+  }
+}
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'syn-tab': SynTab;
+  }
+}

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

@@ -0,0 +1,94 @@
+import { css } from 'lit';
+
+export default css`
+  :host {
+    --background-color: none;
+    --border-width: var(--syn-border-width-none);
+    --border-color: none;
+    --border-radius: var(--syn-border-radius-none);
+  }
+
+  .tab {
+    border-color: transparent;
+    border-radius: var(--border-radius);
+    border-style: solid;
+    border-width: var(--border-width);
+    color: var(--syn-typography-color-text);
+    font: var(--syn-body-small-bold);
+    min-height: var(--syn-spacing-2x-large);
+    padding: var(--syn-spacing-small) var(--syn-spacing-large);
+
+    /* Stretch the tabs so they are aligned to each other vertically and the focus width stays the same  */
+    width: 100%;
+  }
+
+
+  /** #429: Use token for opacity */
+  .tab.tab--disabled {
+    opacity: var(--syn-opacity-50);
+  }
+
+  /**
+   * Focus
+   */
+  :host(:focus-visible) {
+    outline-offset: calc(var(--syn-focus-ring-offset) * -1);
+  }
+
+  :host(:focus-visible:not(.tab--disabled)) {
+    color: var(--syn-typography-color-text);
+  }
+
+  @media (forced-colors: active) {
+    .tab.tab--active:not(.tab--disabled) {
+      outline-offset: calc(var(--syn-focus-ring-offset) * -1);
+    }
+  }
+
+  .tab:hover:not(.tab--disabled) {
+    color: var(--syn-interactive-emphasis-color);
+  }
+
+  .tab.tab--active:not(:hover):not(.tab--disabled) {
+    color: var(--syn-typography-color-text);
+  }
+
+  /**
+   * Closable
+   */
+  .tab.tab--closable {
+    padding: var(--syn-spacing-2x-small) var(--syn-spacing-large);
+  }
+
+  .tab__close-button {
+    color: var(--syn-input-icon-icon-clearable-color);
+    font-size: var(--syn-font-size-x-large);
+    margin-inline-start: var(--syn-spacing-2x-small);
+  }
+
+  .tab__close-button::part(base) {
+    padding: var(--syn-spacing-x-small);
+  }
+
+  .tab__close-button::part(base):hover {
+    color: var(--syn-input-icon-icon-clearable-color-hover);
+  }
+
+  .tab--active {
+    background-color: var(--background-color);
+    border-color: var(--border-color);
+    border-style: solid;
+    border-width: var(--border-width);
+  }
+
+  /* Slotted icon style */
+  .tab ::slotted(syn-icon) {
+    font-size: var(--syn-font-size-x-large);
+    margin-inline-end: var(--syn-spacing-x-small);
+  }
+
+  /* #969: Prevent interactive color when close button is hovered */
+  .tab.tab--closable:hover:has(.tab__close-button:hover) {
+    color: var(--syn-typography-color-text);
+  }
+`;

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

@@ -0,0 +1,70 @@
+/* eslint-disable */
+import { css } from 'lit';
+
+export default css`
+	/* stylelint-disable */
+  :host {
+    display: inline-block;
+  }
+
+  .tab {
+    display: inline-flex;
+    align-items: center;
+    font-family: var(--syn-font-sans);
+    font-size: var(--syn-font-size-small);
+    font-weight: var(--syn-font-weight-semibold);
+    border-radius: var(--syn-border-radius-medium);
+    color: var(--syn-color-neutral-600);
+    padding: var(--syn-spacing-medium) var(--syn-spacing-large);
+    white-space: nowrap;
+    user-select: none;
+    -webkit-user-select: none;
+    cursor: pointer;
+    transition:
+      var(--transition-speed) box-shadow,
+      var(--transition-speed) color;
+  }
+
+  .tab:hover:not(.tab--disabled) {
+    color: var(--syn-color-primary-600);
+  }
+
+  :host(:focus) {
+    outline: transparent;
+  }
+
+  :host(:focus-visible) {
+    color: var(--syn-color-primary-600);
+    outline: var(--syn-focus-ring);
+    outline-offset: calc(-1 * var(--syn-focus-ring-width) - var(--syn-focus-ring-offset));
+  }
+
+  .tab.tab--active:not(.tab--disabled) {
+    color: var(--syn-color-primary-600);
+  }
+
+  .tab.tab--closable {
+    padding-inline-end: var(--syn-spacing-small);
+  }
+
+  .tab.tab--disabled {
+    opacity: 0.5;
+    cursor: not-allowed;
+  }
+
+  .tab__close-button {
+    font-size: var(--syn-font-size-small);
+    margin-inline-start: var(--syn-spacing-small);
+  }
+
+  .tab__close-button::part(base) {
+    padding: var(--syn-spacing-3x-small);
+  }
+
+  @media (forced-colors: active) {
+    .tab.tab--active:not(.tab--disabled) {
+      outline: solid 1px transparent;
+      outline-offset: -3px;
+    }
+  }
+`;

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

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

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

@@ -0,0 +1,4 @@
+export type SynTabJSXElement = SynCustomElement<
+  SynTab,
+  [['syn-close', SynCloseEvent]]
+>;

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

@@ -0,0 +1,42 @@
+// ---------------------------------------------------------------------
+// 🔒 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/tab/tab.component.js';
+
+import { type EventName } from '@lit/react';
+import type { SynCloseEvent } from '@synergy-design-system/components';
+
+const tagName = 'syn-tab';
+Component.define('syn-tab');
+
+/**
+ * @summary Tabs are used inside [tab groups](/components/tab-group) to represent and activate [tab panels](/components/tab-panel).
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-tab--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @dependency syn-icon-button
+ *
+ * @slot - The tab's label.
+ *
+ * @event syn-close - Emitted when the tab is closable and the close button is activated.
+ *
+ * @csspart base - The component's base wrapper.
+ * @csspart close-button - The close button, an `<syn-icon-button>`.
+ * @csspart close-button__base - The close button's exported `base` part.
+ */
+export const SynTab = createComponent({
+  displayName: 'SynTab',
+  elementClass: Component,
+  events: {
+    onSynClose: 'syn-close' as EventName<SynCloseEvent>,
+  },
+  react: React,
+  tagName,
+});
+
+export type { SynCloseEvent } from '@synergy-design-system/components';

package/data/layers/full/component/component:syn-tab/vue/SynVueTab.vue

@@ -0,0 +1,91 @@
+<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 Tabs are used inside [tab groups](/components/tab-group) to represent and activate [tab panels](/components/tab-panel).
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-tab--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @dependency syn-icon-button
+ *
+ * @slot - The tab's label.
+ *
+ * @event syn-close - Emitted when the tab is closable and the close button is activated.
+ *
+ * @csspart base - The component's base wrapper.
+ * @csspart close-button - The close button, an `<syn-icon-button>`.
+ * @csspart close-button__base - The close button's exported `base` part.
+ */
+import { computed, ref } from 'vue';
+import '@synergy-design-system/components/components/tab/tab.js';
+
+import type { SynCloseEvent } from '@synergy-design-system/components';
+import type { SynTab } from '@synergy-design-system/components';
+
+// DOM Reference to the element
+const nativeElement = ref<SynTab>();
+
+defineExpose({
+  nativeElement,
+});
+
+// Map attributes
+const props = defineProps<{
+  /**
+   * The name of the tab panel this tab is associated with.
+   * The panel must be located in the same tab group.
+   */
+  panel?: SynTab['panel'];
+
+  /**
+   * Draws the tab in an active state.
+   */
+  active?: SynTab['active'];
+
+  /**
+   * Makes the tab closable and shows a close button.
+   */
+  closable?: SynTab['closable'];
+
+  /**
+   * Disables the tab and prevents selection.
+   */
+  disabled?: SynTab['disabled'];
+}>();
+
+// 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 tab is closable and the close button is activated.
+   */
+  'syn-close': [e: SynCloseEvent];
+}>();
+</script>
+
+<script lang="ts">
+export type { SynCloseEvent } from '@synergy-design-system/components';
+</script>
+
+<template>
+  <syn-tab
+    @syn-close="$emit('syn-close', $event)"
+    v-bind="visibleProps"
+    ref="nativeElement">
+    <slot></slot>
+  </syn-tab>
+</template>

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

@@ -0,0 +1,166 @@
+// ---------------------------------------------------------------------
+// 🔒 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 { SynTabGroup } from '@synergy-design-system/components';
+import type { SynTabShowEvent } from '@synergy-design-system/components';
+import type { SynTabHideEvent } from '@synergy-design-system/components';
+import '@synergy-design-system/components/components/tab-group/tab-group.js';
+
+/**
+ * @summary Tab groups organize content into a container that shows one section at a time.
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-tab-group--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @dependency syn-icon-button
+ *
+ * @slot - Used for grouping tab panels in the tab group. Must be `<syn-tab-panel>` elements.
+ * @slot nav - Used for grouping tabs in the tab group. Must be `<syn-tab>` elements.
+ *
+ * @event {{ name: String }} syn-tab-show - Emitted when a tab is shown. The payload of the event returns the "panel" attribute of the shown tab.
+ * @event {{ name: String }} syn-tab-hide - Emitted when a tab is hidden. The payload of the event returns the "panel" attribute of the hidden tab.
+ *
+ * @csspart base - The component's base wrapper.
+ * @csspart nav - The tab group's navigation container where tabs are slotted in.
+ * @csspart tabs - The container that wraps the tabs.
+ * @csspart active-tab-indicator - The line that highlights the currently selected tab.
+ * @csspart body - The tab group's body where tab panels are slotted in.
+ * @csspart scroll-button - The previous/next scroll buttons that show when tabs are scrollable, an `<syn-icon-button>`.
+ * @csspart scroll-button--start - The starting scroll button.
+ * @csspart scroll-button--end - The ending scroll button.
+ * @csspart scroll-button__base - The scroll button's exported `base` part.
+ *
+ * @cssproperty --indicator-color - The color of the active tab indicator.
+ * @cssproperty --track-color - The color of the indicator's track (the line that separates tabs from panels).
+ * @cssproperty --track-width - The width of the indicator's track (the line that separates tabs from panels).
+ * @cssproperty --indicator-width - The width of the active tab indicator.
+ */
+@Component({
+  selector: 'syn-tab-group',
+  standalone: true,
+  template: '<ng-content></ng-content>',
+})
+export class SynTabGroupComponent {
+  public nativeElement: SynTabGroup;
+  private _ngZone: NgZone;
+
+  constructor(e: ElementRef, ngZone: NgZone) {
+    this.nativeElement = e.nativeElement;
+    this._ngZone = ngZone;
+    this.nativeElement.addEventListener(
+      'syn-tab-show',
+      (e: SynTabShowEvent) => {
+        this.synTabShowEvent.emit(e);
+      },
+    );
+    this.nativeElement.addEventListener(
+      'syn-tab-hide',
+      (e: SynTabHideEvent) => {
+        this.synTabHideEvent.emit(e);
+      },
+    );
+  }
+
+  /**
+   * The placement of the tabs.
+   */
+  @Input()
+  set placement(v: SynTabGroup['placement']) {
+    this._ngZone.runOutsideAngular(() => (this.nativeElement.placement = v));
+  }
+  get placement(): SynTabGroup['placement'] {
+    return this.nativeElement.placement;
+  }
+
+  /**
+* When set to auto, navigating tabs with the arrow keys will instantly show the corresponding tab panel.
+* When set to
+manual, the tab will receive focus but will not show until the user presses spacebar or enter.
+ */
+  @Input()
+  set activation(v: SynTabGroup['activation']) {
+    this._ngZone.runOutsideAngular(() => (this.nativeElement.activation = v));
+  }
+  get activation(): SynTabGroup['activation'] {
+    return this.nativeElement.activation;
+  }
+
+  /**
+   * Disables the scroll arrows that appear when tabs overflow.
+   */
+  @Input()
+  set noScrollControls(v: '' | SynTabGroup['noScrollControls']) {
+    this._ngZone.runOutsideAngular(
+      () => (this.nativeElement.noScrollControls = v === '' || v),
+    );
+  }
+  get noScrollControls(): SynTabGroup['noScrollControls'] {
+    return this.nativeElement.noScrollControls;
+  }
+
+  /**
+   * Draws the tab group as a contained element.
+   */
+  @Input()
+  set contained(v: '' | SynTabGroup['contained']) {
+    this._ngZone.runOutsideAngular(
+      () => (this.nativeElement.contained = v === '' || v),
+    );
+  }
+  get contained(): SynTabGroup['contained'] {
+    return this.nativeElement.contained;
+  }
+
+  /**
+   * Draws the tab group with edges instead of roundings.
+   * Takes only effect if used with the 'contained' property
+   */
+  @Input()
+  set sharp(v: '' | SynTabGroup['sharp']) {
+    this._ngZone.runOutsideAngular(
+      () => (this.nativeElement.sharp = v === '' || v),
+    );
+  }
+  get sharp(): SynTabGroup['sharp'] {
+    return this.nativeElement.sharp;
+  }
+
+  /**
+   * Prevent scroll buttons from being hidden when inactive.
+   */
+  @Input()
+  set fixedScrollControls(v: '' | SynTabGroup['fixedScrollControls']) {
+    this._ngZone.runOutsideAngular(
+      () => (this.nativeElement.fixedScrollControls = v === '' || v),
+    );
+  }
+  get fixedScrollControls(): SynTabGroup['fixedScrollControls'] {
+    return this.nativeElement.fixedScrollControls;
+  }
+
+  /**
+   * Emitted when a tab is shown.
+   * The payload of the event returns the "panel" attribute of the shown tab.
+   */
+  @Output() synTabShowEvent = new EventEmitter<SynTabShowEvent>();
+
+  /**
+   * Emitted when a tab is hidden.
+   * The payload of the event returns the "panel" attribute of the hidden tab.
+   */
+  @Output() synTabHideEvent = new EventEmitter<SynTabHideEvent>();
+}
+
+export type { SynTabShowEvent } from '@synergy-design-system/components';
+export type { SynTabHideEvent } from '@synergy-design-system/components';