@synergy-design-system/metadata 1.0.0 → 3.0.1

package/data/layers/examples/component/component:syn-details.md

@@ -0,0 +1,202 @@
+## Default
+
+Details show a brief summary and expand to show additional content. If you want to group the details, we recommend that you use the syn-accordion component.
+
+```html
+<syn-details summary="Toggle Me" contained="">
+  <h3
+    style="
+      margin: 0 0 var(--syn-spacing-x-small);
+      font: var(--syn-body-small-bold);
+    "
+  >
+    Subheadline
+  </h3>
+  Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+  eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+  voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+</syn-details>
+```
+
+---
+
+## Open
+
+Details show a brief summary and expand to show additional content.
+
+```html
+<syn-details summary="Toggle Me" open="">
+  <h3
+    style="
+      margin: 0 0 var(--syn-spacing-x-small);
+      font: var(--syn-body-small-bold);
+    "
+  >
+    Subheadline
+  </h3>
+  Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+  eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+  voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+</syn-details>
+```
+
+---
+
+## Contained
+
+To give content more structure, you can use the property contained.
+
+```html
+<syn-details summary="Toggle Me" contained="">
+  <h3
+    style="
+      margin: 0 0 var(--syn-spacing-x-small);
+      font: var(--syn-body-small-bold);
+    "
+  >
+    Subheadline
+  </h3>
+  Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+  eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+  voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+</syn-details>
+<br />
+<syn-details summary="Toggle Me" open="" contained="">
+  <h3
+    style="
+      margin: 0 0 var(--syn-spacing-x-small);
+      font: var(--syn-body-small-bold);
+    "
+  >
+    Subheadline
+  </h3>
+  Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+  eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+  voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+</syn-details>
+```
+
+---
+
+## Focus
+
+The focus event gives the user feedback that the detail has been focused by the keyboard interaction.
+
+```html
+<div style="padding: 5px">
+  <syn-details summary="Toggle Me" contained="">
+    <h3
+      style="
+        margin: 0 0 var(--syn-spacing-x-small);
+        font: var(--syn-body-small-bold);
+      "
+    >
+      Subheadline
+    </h3>
+    Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+    eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+    voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+  </syn-details>
+</div>
+```
+
+---
+
+## Disabled
+
+Use the disable attribute to prevent the details from expanding.
+
+```html
+<syn-details summary="Toggle Me" disabled="">
+  <h3
+    style="
+      margin: 0 0 var(--syn-spacing-x-small);
+      font: var(--syn-body-small-bold);
+    "
+  >
+    Subheadline
+  </h3>
+  Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+  eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+  voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+</syn-details>
+```
+
+---
+
+## Sizes
+
+Use the size attribute to change a detail’s size.
+
+```html
+<div
+  style="display: flex; gap: var(--syn-spacing-x-small); flex-direction: column"
+>
+  <syn-details size="small" contained="">
+    <span slot="summary">Toggle Me</span>
+    <h3
+      style="
+        margin: 0 0 var(--syn-spacing-x-small);
+        font: var(--syn-body-x-small-bold);
+      "
+    >
+      Subheadline
+    </h3>
+    Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+    eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+    voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+  </syn-details>
+  <syn-details size="medium" contained="">
+    <span slot="summary">Toggle Me</span>
+    <h3
+      style="
+        margin: 0 0 var(--syn-spacing-x-small);
+        font: var(--syn-body-small-bold);
+      "
+    >
+      Subheadline
+    </h3>
+    Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+    eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+    voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+  </syn-details>
+  <syn-details size="large" contained="">
+    <span slot="summary">Toggle Me</span>
+    <h3
+      style="
+        margin: 0 0 var(--syn-spacing-x-small);
+        font: var(--syn-body-medium-bold);
+      "
+    >
+      Subheadline
+    </h3>
+    Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+    eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+    voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+  </syn-details>
+</div>
+```
+
+---
+
+## Prefix Icons
+
+Use the prefix Icon to prepend an icon to the details.
+
+```html
+<syn-details open="">
+  <syn-icon name="home" slot="summary"></syn-icon>
+  <span slot="summary">Accordion Element</span>
+  <h3
+    style="
+      margin: 0 0 var(--syn-spacing-x-small);
+      font: var(--syn-body-small-bold);
+    "
+  >
+    Subheadline
+  </h3>
+  Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+  eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+  voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+</syn-details>
+```

package/data/layers/examples/component/component:syn-dialog.md

@@ -0,0 +1,349 @@
+## Default
+
+Dialogs, sometimes called "modals", appear above the page and require the user's immediate attention.
+
+```html
+<syn-dialog open="" label="Dialog">
+  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+  <span slot="footer"> </span>
+  <syn-button class="default-close-icon" variant="filled" slot="footer"
+    >Close</syn-button
+  >
+  <span slot="footer"> </span>
+  <script slot="footer">
+    [...document.querySelectorAll(".default-close-icon")].forEach((elm) => {
+      elm.addEventListener("click", (e) => {
+        const dialog = e.target.closest("syn-dialog");
+        dialog.label += " - Clicked";
+        dialog.hide();
+        dialog.modal.deactivateExternal();
+      });
+    });
+  </script>
+  <span slot="footer"> </span>
+</syn-dialog>
+
+<syn-button class="dialog-default-story-opener">Open Dialog</syn-button>
+<script type="module">
+  const createOpener = (opener) => {
+    // Storybook only: When loading the docs page, all dialogs are applying a focus trap.
+    // Remove the initial trap and make sure to do the same when recreating the story.
+    const loadedDialog = opener.parentElement.querySelector("syn-dialog");
+    loadedDialog.modal.activateExternal();
+
+    opener.addEventListener("click", (e) => {
+      const currentDialog = e.target.parentElement.querySelector("syn-dialog");
+      currentDialog.show();
+      currentDialog.modal.activateExternal();
+    });
+  };
+
+  [...document.querySelectorAll(".dialog-default-story-opener")].forEach(
+    (i) => {
+      createOpener(i);
+    },
+  );
+</script>
+```
+
+---
+
+## Custom Width
+
+Use the --width custom property to set the dialog’s width.
+
+```html
+<syn-dialog open="" label="Dialog" style="--width: 50vw">
+  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+
+  <syn-button class="dialog-custom-width" variant="filled" slot="footer"
+    >Close</syn-button
+  >
+  <script>
+    [...document.querySelectorAll(".dialog-custom-width")].forEach((elm) => {
+      elm.addEventListener("click", (e) => {
+        const dialog = e.target.closest("syn-dialog");
+        dialog.label += " - Clicked";
+        dialog.hide();
+        dialog.modal.deactivateExternal();
+      });
+    });
+  </script>
+</syn-dialog>
+
+<syn-button class="dialog-custom-width-story-opener">Open Dialog</syn-button>
+<script type="module">
+  const createOpener = (opener) => {
+    // Storybook only: When loading the docs page, all dialogs are applying a focus trap.
+    // Remove the initial trap and make sure to do the same when recreating the story.
+    const loadedDialog = opener.parentElement.querySelector("syn-dialog");
+    loadedDialog.modal.activateExternal();
+
+    opener.addEventListener("click", (e) => {
+      const currentDialog = e.target.parentElement.querySelector("syn-dialog");
+      currentDialog.show();
+      currentDialog.modal.activateExternal();
+    });
+  };
+
+  [...document.querySelectorAll(".dialog-custom-width-story-opener")].forEach(
+    (i) => {
+      createOpener(i);
+    },
+  );
+</script>
+```
+
+---
+
+## Scrolling
+
+By design, a dialog’s height will never exceed that of the viewport. As such, dialogs will not scroll with the page ensuring the header and footer are always accessible to the user.
+
+```html
+<syn-dialog open="" label="Dialog">
+  <div>
+    <p>Scroll down and give it a try! 👇</p>
+    <p>
+      Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+      eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+      voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet
+      clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit
+      amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
+      nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed
+      diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+      Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+      sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed
+      diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam
+      erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea
+      rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum
+      dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
+      sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam
+      erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea
+      rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum
+      dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
+      sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam
+      erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea
+      rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum
+      dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
+      sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam
+      erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea
+      rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum
+      dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
+      sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam
+      erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea
+      rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum
+      dolor sit amet.
+    </p>
+  </div>
+
+  <syn-button class="dialog-scrolling" variant="filled" slot="footer"
+    >Close</syn-button
+  >
+  <script>
+    [...document.querySelectorAll(".dialog-scrolling")].forEach((elm) => {
+      elm.addEventListener("click", (e) => {
+        const dialog = e.target.closest("syn-dialog");
+        dialog.label += " - Clicked";
+        dialog.hide();
+        dialog.modal.deactivateExternal();
+      });
+    });
+  </script>
+</syn-dialog>
+
+<syn-button class="dialog-scrolling-story-opener">Open Dialog</syn-button>
+<script type="module">
+  const createOpener = (opener) => {
+    // Storybook only: When loading the docs page, all dialogs are applying a focus trap.
+    // Remove the initial trap and make sure to do the same when recreating the story.
+    const loadedDialog = opener.parentElement.querySelector("syn-dialog");
+    loadedDialog.modal.activateExternal();
+
+    opener.addEventListener("click", (e) => {
+      const currentDialog = e.target.parentElement.querySelector("syn-dialog");
+      currentDialog.show();
+      currentDialog.modal.activateExternal();
+    });
+  };
+
+  [...document.querySelectorAll(".dialog-scrolling-story-opener")].forEach(
+    (i) => {
+      createOpener(i);
+    },
+  );
+</script>
+```
+
+---
+
+## Header Actions
+
+The header shows a functional close button by default. You can use the header-actions slot to add additional icon buttons if needed.
+
+```html
+<syn-dialog open="" label="Dialog">
+  <syn-icon-button
+    class="new-window"
+    slot="header-actions"
+    name="open_in_new"
+    label="Open in new Tab"
+  ></syn-icon-button>
+  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+
+  <syn-button class="dialog-header-actions" variant="filled" slot="footer"
+    >Close</syn-button
+  >
+  <script>
+    [...document.querySelectorAll(".dialog-header-actions")].forEach((elm) => {
+      elm.addEventListener("click", (e) => {
+        const dialog = e.target.closest("syn-dialog");
+        dialog.label += " - Clicked";
+        dialog.hide();
+        dialog.modal.deactivateExternal();
+      });
+    });
+  </script>
+</syn-dialog>
+<script type="module">
+  document
+    .querySelector(".new-window")
+    .addEventListener("click", () => window.open(location.href));
+</script>
+
+<syn-button class="dialog-header-actions-story-opener">Open Dialog</syn-button>
+<script type="module">
+  const createOpener = (opener) => {
+    // Storybook only: When loading the docs page, all dialogs are applying a focus trap.
+    // Remove the initial trap and make sure to do the same when recreating the story.
+    const loadedDialog = opener.parentElement.querySelector("syn-dialog");
+    loadedDialog.modal.activateExternal();
+
+    opener.addEventListener("click", (e) => {
+      const currentDialog = e.target.parentElement.querySelector("syn-dialog");
+      currentDialog.show();
+      currentDialog.modal.activateExternal();
+    });
+  };
+
+  [...document.querySelectorAll(".dialog-header-actions-story-opener")].forEach(
+    (i) => {
+      createOpener(i);
+    },
+  );
+</script>
+```
+
+---
+
+## Preventing The Dialog From Closing
+
+By default, dialogs will close when the user clicks the close button, clicks the overlay, or presses the Escape key. In most cases, the default behavior is the best behavior in terms of UX. However, there are situations where this may be undesirable, such as when data loss will occur.To keep the dialog open in such cases, you can cancel the syn-request-close event. When canceled, the dialog will remain open and pulse briefly to draw the user’s attention to it.You can use event.detail.source to determine what triggered the request to close. This example prevents the dialog from closing when the overlay is clicked, but allows the close button or Escape to dismiss it.
+
+```html
+<syn-dialog open="" label="Dialog" class="dialog-deny-close">
+  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+
+  <syn-button class="dialog-deny-close-actions" variant="filled" slot="footer"
+    >Close</syn-button
+  >
+  <script>
+    [...document.querySelectorAll(".dialog-deny-close-actions")].forEach(
+      (elm) => {
+        elm.addEventListener("click", (e) => {
+          const dialog = e.target.closest("syn-dialog");
+          dialog.label += " - Clicked";
+          dialog.hide();
+          dialog.modal.deactivateExternal();
+        });
+      },
+    );
+  </script>
+</syn-dialog>
+<script type="module">
+  const dialog = document.querySelector(".dialog-deny-close");
+  dialog.addEventListener("syn-request-close", (event) => {
+    if (event.detail.source === "overlay") {
+      event.preventDefault();
+    }
+  });
+</script>
+
+<syn-button class="dialog-deny-close-story-opener">Open Dialog</syn-button>
+<script type="module">
+  const createOpener = (opener) => {
+    // Storybook only: When loading the docs page, all dialogs are applying a focus trap.
+    // Remove the initial trap and make sure to do the same when recreating the story.
+    const loadedDialog = opener.parentElement.querySelector("syn-dialog");
+    loadedDialog.modal.activateExternal();
+
+    opener.addEventListener("click", (e) => {
+      const currentDialog = e.target.parentElement.querySelector("syn-dialog");
+      currentDialog.show();
+      currentDialog.modal.activateExternal();
+    });
+  };
+
+  [...document.querySelectorAll(".dialog-deny-close-story-opener")].forEach(
+    (i) => {
+      createOpener(i);
+    },
+  );
+</script>
+```
+
+---
+
+## Customizing Initial Focus
+
+By default, the dialog’s panel will gain focus when opened. This allows a subsequent tab press to focus on the first tabbable element in the dialog. If you want a different element to have focus, add the autofocus attribute to it as shown below.
+
+```html
+<syn-dialog label="Dialog">
+  <syn-input
+    autofocus=""
+    placeholder="I will have focus when the dialog is opened"
+  ></syn-input>
+
+  <syn-button
+    class="dialog-initial-focus-actions"
+    variant="filled"
+    slot="footer"
+    >Close</syn-button
+  >
+  <script>
+    [...document.querySelectorAll(".dialog-initial-focus-actions")].forEach(
+      (elm) => {
+        elm.addEventListener("click", (e) => {
+          const dialog = e.target.closest("syn-dialog");
+          dialog.label += " - Clicked";
+          dialog.hide();
+          dialog.modal.deactivateExternal();
+        });
+      },
+    );
+  </script>
+</syn-dialog>
+
+<syn-button class="dialog-initial-focus-story-opener">Open Dialog</syn-button>
+<script type="module">
+  const createOpener = (opener) => {
+    // Storybook only: When loading the docs page, all dialogs are applying a focus trap.
+    // Remove the initial trap and make sure to do the same when recreating the story.
+    const loadedDialog = opener.parentElement.querySelector("syn-dialog");
+    loadedDialog.modal.activateExternal();
+
+    opener.addEventListener("click", (e) => {
+      const currentDialog = e.target.parentElement.querySelector("syn-dialog");
+      currentDialog.show();
+      currentDialog.modal.activateExternal();
+    });
+  };
+
+  [...document.querySelectorAll(".dialog-initial-focus-story-opener")].forEach(
+    (i) => {
+      createOpener(i);
+    },
+  );
+</script>
+```

package/data/layers/examples/component/component:syn-divider.md

@@ -0,0 +1,57 @@
+## Default
+
+Dividers are used to visually separate or group elements.
+
+```html
+<syn-divider></syn-divider>
+```
+
+---
+
+## Width
+
+Use the --width custom property to change the width of the divider.
+
+```html
+<syn-divider style="--width: var(--syn-spacing-x-small)"></syn-divider>
+```
+
+---
+
+## Color
+
+Use the --color custom property to change the color of the divider.
+
+```html
+<syn-divider style="--color: var(--syn-color-primary-600)"></syn-divider>
+```
+
+---
+
+## Spacing
+
+Use the --spacing custom property to change the amount of space between the divider and it’s neighboring elements.
+
+```html
+<div style="text-align: center">
+  Above
+  <syn-divider style="--spacing: var(--syn-spacing-large)"></syn-divider>
+  Below
+</div>
+```
+
+---
+
+## Vertical
+
+Add the vertical attribute to draw the divider in a vertical orientation. The divider will span the full height of its container. Vertical dividers work especially well inside of a flex container.
+
+```html
+<div style="display: flex; align-items: center; height: 2rem">
+  First
+  <syn-divider vertical=""></syn-divider>
+  Middle
+  <syn-divider vertical=""></syn-divider>
+  Last
+</div>
+```