@synergy-design-system/metadata 1.0.0 → 3.0.1

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

@@ -0,0 +1,65 @@
+/* eslint-disable */
+import { classMap } from 'lit/directives/class-map.js';
+import { property } from 'lit/decorators.js';
+import { HasSlotController } from '../../internal/slot.js';
+import { html } from 'lit';
+import componentStyles from '../../styles/component.styles.js';
+import SynergyElement from '../../internal/synergy-element.js';
+import styles from './card.styles.js';
+import customStyles from './card.custom.styles.js';
+import type { CSSResultGroup } from 'lit';
+
+/**
+ * @summary Cards can be used to group related subjects in a container.
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-card--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @slot - The card's main content.
+ * @slot header - An optional header for the card.
+ * @slot footer - An optional footer for the card.
+ * @slot image - An optional image to render at the start of the card.
+ *
+ * @csspart base - The component's base wrapper.
+ * @csspart image - The container that wraps the card's image.
+ * @csspart header - The container that wraps the card's header.
+ * @csspart body - The container that wraps the card's main content.
+ * @csspart footer - The container that wraps the card's footer.
+ *
+ * @cssproperty --border-color - The card's border color, including borders that occur inside the card.
+ * @cssproperty --border-radius - The border radius for the card's edges.
+ * @cssproperty --border-width - The width of the card's borders.
+ * @cssproperty --padding - The padding to use for the card's sections.
+ */
+export default class SynCard extends SynergyElement {
+  static styles: CSSResultGroup = [componentStyles, styles, customStyles];
+
+  private readonly hasSlotController = new HasSlotController(this, 'footer', 'header', 'image');
+
+  /** Draws the card with a shadow. Can be used when the card has to stand out visually, for example in dashboards. */
+  @property({ type: Boolean, reflect: true }) shadow = false;
+
+  /** Draws the card with sharp edges. Can be used e.g. when nesting multiple syn-cards to create hierarchy. */
+  @property({ type: Boolean, reflect: true }) sharp = false;
+
+  render() {
+    return html`
+      <div
+        part="base"
+        class=${classMap({
+          card: true,
+          'card--shadow': this.shadow,
+          'card--sharp': this.sharp,
+          'card--has-footer': this.hasSlotController.test('footer'),
+          'card--has-image': this.hasSlotController.test('image'),
+          'card--has-header': this.hasSlotController.test('header')
+        })}
+      >
+        <slot name="image" part="image" class="card__image"></slot>
+        <slot name="header" part="header" class="card__header"></slot>
+        <slot part="body" class="card__body"></slot>
+        <slot name="footer" part="footer" class="card__footer"></slot>
+      </div>
+    `;
+  }
+}

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

@@ -0,0 +1,60 @@
+import { css } from 'lit';
+
+export default css`
+  :host {
+    --border-color: var(--syn-panel-border-color);
+    --border-width: var(--syn-border-width-small);
+    --border-radius: var(--syn-border-radius-medium);
+  }
+
+  .card {
+    box-shadow: none;
+  }
+
+  /** #1107: Add shadow property to card */
+  .card--shadow {
+    box-shadow: var(--syn-shadow-small);
+  }
+
+  /**
+   * Header adjustments
+   */
+  .card__header {
+    border: none;
+    color: var(--syn-typography-color-text);
+    font: var(--syn-heading-large);
+    line-height: var(--syn-line-height-normal);
+  }
+
+  /**
+   * Card body
+   */
+  .card__body {
+    color: var(--syn-typography-color-text);
+    font: var(--syn-body-medium-regular);
+  }
+
+  /**
+   * Card Footer
+   */
+  .card--has-footer .card__footer {
+    border-top: none;
+    padding: var(--syn-spacing-x-small) var(--syn-spacing-large) var(--syn-spacing-large);
+  }
+
+  /**
+   * Cards that are sharp do not receive a border radius
+   */
+  .card--sharp {
+    border-radius: var(--syn-border-radius-none);
+  }
+
+  /**
+   * Do not apply border radius to sharp card images
+   */
+  .card--sharp .card__image {
+    border-top-left-radius: var(--syn-border-radius-none);
+    border-top-right-radius: var(--syn-border-radius-none);
+  }
+
+`;

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

@@ -0,0 +1,70 @@
+/* eslint-disable */
+import { css } from 'lit';
+
+export default css`
+	/* stylelint-disable */
+  :host {
+    --border-color: var(--syn-color-neutral-200);
+    --border-radius: var(--syn-border-radius-medium);
+    --border-width: 1px;
+    --padding: var(--syn-spacing-large);
+
+    display: inline-block;
+  }
+
+  .card {
+    display: flex;
+    flex-direction: column;
+    background-color: var(--syn-panel-background-color);
+    box-shadow: var(--syn-shadow-x-small);
+    border: solid var(--border-width) var(--border-color);
+    border-radius: var(--border-radius);
+  }
+
+  .card__image {
+    display: flex;
+    border-top-left-radius: var(--border-radius);
+    border-top-right-radius: var(--border-radius);
+    margin: calc(-1 * var(--border-width));
+    overflow: hidden;
+  }
+
+  .card__image::slotted(img) {
+    display: block;
+    width: 100%;
+  }
+
+  .card:not(.card--has-image) .card__image {
+    display: none;
+  }
+
+  .card__header {
+    display: block;
+    border-bottom: solid var(--border-width) var(--border-color);
+    padding: calc(var(--padding) / 2) var(--padding);
+  }
+
+  .card:not(.card--has-header) .card__header {
+    display: none;
+  }
+
+  .card:not(.card--has-image) .card__header {
+    border-top-left-radius: var(--border-radius);
+    border-top-right-radius: var(--border-radius);
+  }
+
+  .card__body {
+    display: block;
+    padding: var(--padding);
+  }
+
+  .card--has-footer .card__footer {
+    display: block;
+    border-top: solid var(--border-width) var(--border-color);
+    padding: var(--padding);
+  }
+
+  .card:not(.card--has-footer) .card__footer {
+    display: none;
+  }
+`;

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

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

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

@@ -0,0 +1 @@
+export type SynCardJSXElement = SynCustomElement<SynCard, []>;

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

@@ -0,0 +1,41 @@
+// ---------------------------------------------------------------------
+// 🔒 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/card/card.component.js';
+
+const tagName = 'syn-card';
+Component.define('syn-card');
+
+/**
+ * @summary Cards can be used to group related subjects in a container.
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-card--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @slot - The card's main content.
+ * @slot header - An optional header for the card.
+ * @slot footer - An optional footer for the card.
+ * @slot image - An optional image to render at the start of the card.
+ *
+ * @csspart base - The component's base wrapper.
+ * @csspart image - The container that wraps the card's image.
+ * @csspart header - The container that wraps the card's header.
+ * @csspart body - The container that wraps the card's main content.
+ * @csspart footer - The container that wraps the card's footer.
+ *
+ * @cssproperty --border-color - The card's border color, including borders that occur inside the card.
+ * @cssproperty --border-radius - The border radius for the card's edges.
+ * @cssproperty --border-width - The width of the card's borders.
+ * @cssproperty --padding - The padding to use for the card's sections.
+ */
+export const SynCard = createComponent({
+  displayName: 'SynCard',
+  elementClass: Component,
+  events: {},
+  react: React,
+  tagName,
+});

package/data/layers/full/component/component:syn-card/vue/SynVueCard.vue

@@ -0,0 +1,73 @@
+<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 Cards can be used to group related subjects in a container.
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-card--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @slot - The card's main content.
+ * @slot header - An optional header for the card.
+ * @slot footer - An optional footer for the card.
+ * @slot image - An optional image to render at the start of the card.
+ *
+ * @csspart base - The component's base wrapper.
+ * @csspart image - The container that wraps the card's image.
+ * @csspart header - The container that wraps the card's header.
+ * @csspart body - The container that wraps the card's main content.
+ * @csspart footer - The container that wraps the card's footer.
+ *
+ * @cssproperty --border-color - The card's border color, including borders that occur inside the card.
+ * @cssproperty --border-radius - The border radius for the card's edges.
+ * @cssproperty --border-width - The width of the card's borders.
+ * @cssproperty --padding - The padding to use for the card's sections.
+ */
+import { computed, ref } from 'vue';
+import '@synergy-design-system/components/components/card/card.js';
+
+import type { SynCard } from '@synergy-design-system/components';
+
+// DOM Reference to the element
+const nativeElement = ref<SynCard>();
+
+defineExpose({
+  nativeElement,
+});
+
+// Map attributes
+const props = defineProps<{
+  /**
+   * Draws the card with a shadow.
+   * Can be used when the card has to stand out visually, for example in dashboards.
+   */
+  shadow?: SynCard['shadow'];
+
+  /**
+   * Draws the card with sharp edges.
+   * Can be used e.g.
+   * when nesting multiple syn-cards to create hierarchy.
+   */
+  sharp?: SynCard['sharp'];
+}>();
+
+// 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-card v-bind="visibleProps" ref="nativeElement">
+    <slot></slot>
+  </syn-card>
+</template>

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

@@ -0,0 +1,273 @@
+// ---------------------------------------------------------------------
+// 🔒 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 { SynCheckbox } 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 '@synergy-design-system/components/components/checkbox/checkbox.js';
+
+/**
+ * @summary Checkboxes allow the user to toggle an option on or off.
+ * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-checkbox--docs
+ * @status stable
+ * @since 2.0
+ *
+ * @dependency syn-icon
+ *
+ * @slot - The checkbox's label.
+ * @slot help-text - Text that describes how to use the checkbox. Alternatively, you can use the `help-text` attribute.
+ *
+ * @event syn-blur - Emitted when the checkbox loses focus.
+ * @event syn-change - Emitted when the checked state changes.
+ * @event syn-focus - Emitted when the checkbox gains focus.
+ * @event syn-input - Emitted when the checkbox receives input.
+ * @event syn-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
+ *
+ * @csspart base - The component's base wrapper.
+ * @csspart control - The square container that wraps the checkbox's checked state.
+ * @csspart control--checked - Matches the control part when the checkbox is checked.
+ * @csspart control--indeterminate - Matches the control part when the checkbox is indeterminate.
+ * @csspart checked-icon - The checked icon, an `<syn-icon>` element.
+ * @csspart indeterminate-icon - The indeterminate icon, an `<syn-icon>` element.
+ * @csspart label - The container that wraps the checkbox's label.
+ * @csspart form-control-help-text - The help text's wrapper.
+ */
+@Component({
+  selector: 'syn-checkbox',
+  standalone: true,
+  template: '<ng-content></ng-content>',
+})
+export class SynCheckboxComponent {
+  public nativeElement: SynCheckbox;
+  private _ngZone: NgZone;
+  private modelSignal = new AbortController();
+
+  constructor(e: ElementRef, ngZone: NgZone) {
+    this.nativeElement = e.nativeElement;
+    this._ngZone = ngZone;
+    this.nativeElement.addEventListener('syn-blur', (e: SynBlurEvent) => {
+      this.synBlurEvent.emit(e);
+    });
+    this.nativeElement.addEventListener('syn-change', (e: SynChangeEvent) => {
+      this.synChangeEvent.emit(e);
+    });
+    this.nativeElement.addEventListener('syn-focus', (e: SynFocusEvent) => {
+      this.synFocusEvent.emit(e);
+    });
+    this.nativeElement.addEventListener('syn-input', (e: SynInputEvent) => {
+      this.synInputEvent.emit(e);
+    });
+    this.nativeElement.addEventListener('syn-invalid', (e: SynInvalidEvent) => {
+      this.synInvalidEvent.emit(e);
+    });
+    this.ngModelUpdateOn = 'syn-input';
+  }
+
+  /**
+   * The event that will trigger the ngModel update.
+   * By default, this is set to "syn-input".
+   */
+  @Input()
+  set ngModelUpdateOn(v: keyof HTMLElementEventMap) {
+    this.modelSignal.abort();
+    this.modelSignal = new AbortController();
+    const option = v || 'syn-input';
+    this.nativeElement.addEventListener(
+      option,
+      () => {
+        this.checkedChange.emit(this.checked);
+      },
+      {
+        signal: this.modelSignal.signal,
+      },
+    );
+  }
+  get ngModelUpdateOn(): keyof HTMLElementEventMap {
+    return this.ngModelUpdateOn;
+  }
+
+  @Input()
+  set title(v: SynCheckbox['title']) {
+    this._ngZone.runOutsideAngular(() => (this.nativeElement.title = v));
+  }
+  get title(): SynCheckbox['title'] {
+    return this.nativeElement.title;
+  }
+
+  /**
+   * The name of the checkbox, submitted as a name/value pair with form data.
+   */
+  @Input()
+  set name(v: SynCheckbox['name']) {
+    this._ngZone.runOutsideAngular(() => (this.nativeElement.name = v));
+  }
+  get name(): SynCheckbox['name'] {
+    return this.nativeElement.name;
+  }
+
+  /**
+   * The current value of the checkbox, submitted as a name/value pair with form data.
+   */
+  @Input()
+  set value(v: SynCheckbox['value']) {
+    this._ngZone.runOutsideAngular(() => (this.nativeElement.value = v));
+  }
+  get value(): SynCheckbox['value'] {
+    return this.nativeElement.value;
+  }
+
+  /**
+   * The checkbox's size.
+   */
+  @Input()
+  set size(v: SynCheckbox['size']) {
+    this._ngZone.runOutsideAngular(() => (this.nativeElement.size = v));
+  }
+  get size(): SynCheckbox['size'] {
+    return this.nativeElement.size;
+  }
+
+  /**
+   * Disables the checkbox.
+   */
+  @Input()
+  set disabled(v: '' | SynCheckbox['disabled']) {
+    this._ngZone.runOutsideAngular(
+      () => (this.nativeElement.disabled = v === '' || v),
+    );
+  }
+  get disabled(): SynCheckbox['disabled'] {
+    return this.nativeElement.disabled;
+  }
+
+  /**
+   * Sets the checkbox to a readonly state.
+   */
+  @Input()
+  set readonly(v: '' | SynCheckbox['readonly']) {
+    this._ngZone.runOutsideAngular(
+      () => (this.nativeElement.readonly = v === '' || v),
+    );
+  }
+  get readonly(): SynCheckbox['readonly'] {
+    return this.nativeElement.readonly;
+  }
+
+  /**
+   * Draws the checkbox in a checked state.
+   */
+  @Input()
+  set checked(v: '' | SynCheckbox['checked']) {
+    this._ngZone.runOutsideAngular(
+      () => (this.nativeElement.checked = v === '' || v),
+    );
+  }
+  get checked(): SynCheckbox['checked'] {
+    return this.nativeElement.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.
+ */
+  @Input()
+  set indeterminate(v: '' | SynCheckbox['indeterminate']) {
+    this._ngZone.runOutsideAngular(
+      () => (this.nativeElement.indeterminate = v === '' || v),
+    );
+  }
+  get indeterminate(): SynCheckbox['indeterminate'] {
+    return this.nativeElement.indeterminate;
+  }
+
+  /**
+* 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.
+ */
+  @Input()
+  set form(v: SynCheckbox['form']) {
+    this._ngZone.runOutsideAngular(() => (this.nativeElement.form = v));
+  }
+  get form(): SynCheckbox['form'] {
+    return this.nativeElement.form;
+  }
+
+  /**
+   * Makes the checkbox a required field.
+   */
+  @Input()
+  set required(v: '' | SynCheckbox['required']) {
+    this._ngZone.runOutsideAngular(
+      () => (this.nativeElement.required = v === '' || v),
+    );
+  }
+  get required(): SynCheckbox['required'] {
+    return this.nativeElement.required;
+  }
+
+  /**
+   * The checkbox's help text.
+   * If you need to display HTML, use the `help-text` slot instead.
+   */
+  @Input()
+  set helpText(v: SynCheckbox['helpText']) {
+    this._ngZone.runOutsideAngular(() => (this.nativeElement.helpText = v));
+  }
+  get helpText(): SynCheckbox['helpText'] {
+    return this.nativeElement.helpText;
+  }
+
+  /**
+   * Emitted when the checkbox loses focus.
+   */
+  @Output() synBlurEvent = new EventEmitter<SynBlurEvent>();
+
+  /**
+   * Emitted when the checked state changes.
+   */
+  @Output() synChangeEvent = new EventEmitter<SynChangeEvent>();
+
+  /**
+   * Emitted when the checkbox gains focus.
+   */
+  @Output() synFocusEvent = new EventEmitter<SynFocusEvent>();
+
+  /**
+   * Emitted when the checkbox receives input.
+   */
+  @Output() synInputEvent = new EventEmitter<SynInputEvent>();
+
+  /**
+   * Emitted when the form control has been checked for validity and its constraints aren't satisfied.
+   */
+  @Output() synInvalidEvent = new EventEmitter<SynInvalidEvent>();
+
+  /**
+   * Support for two way data binding
+   */
+  @Output() checkedChange = new EventEmitter<SynCheckbox['checked']>();
+}
+
+export type { SynBlurEvent } from '@synergy-design-system/components';
+export type { SynChangeEvent } from '@synergy-design-system/components';
+export type { SynFocusEvent } from '@synergy-design-system/components';
+export type { SynInputEvent } from '@synergy-design-system/components';
+export type { SynInvalidEvent } from '@synergy-design-system/components';