@carbon/ibm-products-web-components 0.0.1-canary.3564

package/.storybook/Preview.ts

@@ -0,0 +1,161 @@
+/**
+ * Copyright IBM Corp. 2016, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { setCustomElementsManifest } from '@storybook/web-components';
+import customElements from '../custom-elements.json';
+import container from './container';
+import { white, g10, g90, g100 } from '@carbon/themes';
+import { breakpoints } from '@carbon/layout';
+import theme from './theme';
+import './templates/with-layer';
+
+setCustomElementsManifest(customElements);
+
+export const globalTypes = {
+  theme: {
+    name: 'Theme',
+    description: 'Set the global theme for displaying components',
+    defaultValue: 'white',
+    toolbar: {
+      icon: 'paintbrush',
+      title: 'Theme',
+      items: ['white', 'g10', 'g90', 'g100'],
+    },
+  },
+};
+
+export const parameters = {
+  a11y: {
+    // Can specify engine as "axe" or "accessibility-checker" (axe default)
+    engine: 'accessibility-checker',
+    config: {
+      rules: [
+        {
+          // To disable a rule across all stories, set `enabled` to `false`.
+          // Use with caution: all violations of this rule will be ignored!
+          id: 'html_lang_exists',
+          enabled: false,
+        },
+        { id: 'page_title_exists', enabled: false },
+        { id: 'skip_main_exists', enabled: false },
+        { id: 'html_skipnav_exists', enabled: false },
+        { id: 'aria_content_in_landmark', enabled: false },
+        { id: 'aria_child_tabbable', enabled: false },
+      ],
+    },
+  },
+  actions: { argTypesRegex: '^on.*' },
+  backgrounds: {
+    // https://storybook.js.org/docs/react/essentials/backgrounds#grid
+    grid: {
+      cellSize: 8,
+      opacity: 0.5,
+    },
+    values: [
+      {
+        name: 'white',
+        value: white.background,
+      },
+      {
+        name: 'g10',
+        value: g10.background,
+      },
+      {
+        name: 'g90',
+        value: g90.background,
+      },
+      {
+        name: 'g100',
+        value: g100.background,
+      },
+    ],
+  },
+  controls: {
+    expanded: true,
+    sort: 'alpha',
+    hideNoControlsWarning: true,
+  },
+  docs: {
+    theme,
+  },
+  viewport: {
+    viewports: {
+      sm: {
+        name: 'Small',
+        styles: {
+          width: breakpoints.sm.width,
+          height: '100%',
+        },
+      },
+      md: {
+        name: 'Medium',
+        styles: {
+          width: breakpoints.md.width,
+          height: '100%',
+        },
+      },
+      lg: {
+        name: 'Large',
+        styles: {
+          width: breakpoints.lg.width,
+          height: '100%',
+        },
+      },
+      xlg: {
+        name: 'X-Large',
+        styles: {
+          width: breakpoints.xlg.width,
+          height: '100%',
+        },
+      },
+      Max: {
+        name: 'Max',
+        styles: {
+          width: breakpoints.max.width,
+          height: '100%',
+        },
+      },
+    },
+  },
+  options: {
+    storySort: {
+      method: 'alphabetical',
+      order: [
+        'Introduction',
+        [
+          'Welcome',
+          'Custom styles',
+          'Carbon CDN style helpers',
+          'Form Participation',
+        ],
+        'Components',
+        'Layout',
+      ],
+    },
+  },
+};
+
+export const decorators = [
+  function decoratorContainer(story, context) {
+    const result = story();
+    const { hasMainTag } = result;
+    const { locale, dir, theme } = context.globals;
+
+    document.documentElement.setAttribute('storybook-carbon-theme', theme);
+
+    document.documentElement.lang = locale;
+    document.documentElement.dir = dir;
+
+    return container({ hasMainTag, children: result });
+  },
+];
+
+export default {
+  parameters,
+  globalTypes,
+  decorators,
+};

package/.storybook/_container.scss

@@ -0,0 +1,73 @@
+//
+// @license
+//
+// Copyright IBM Corp. 2024, 2024
+//
+// This source code is licensed under the Apache-2.0 license found in the
+// LICENSE file in the root directory of this source tree.
+//
+
+@use '@carbon/styles' with ($font-path: '@ibm/plex');
+@use '@carbon/styles/scss/config' as *;
+@use '@carbon/themes/scss/themes';
+@use '@carbon/styles/scss/theme';
+@use '@carbon/grid';
+
+@use '@carbon/styles/scss/components/button/tokens' as button-tokens;
+@use '@carbon/styles/scss/components/notification/tokens' as notification-tokens;
+@use '@carbon/styles/scss/components/tag/tokens' as tag-tokens;
+@include theme.add-component-tokens(button-tokens.$button-tokens);
+@include theme.add-component-tokens(notification-tokens.$notification-tokens);
+@include theme.add-component-tokens(tag-tokens.$tag-tokens);
+
+// Emit the flex-grid styles
+@include grid.flex-grid();
+
+*,
+*::before,
+*::after {
+  box-sizing: border-box;
+}
+
+// The default theme is "white" (White)
+:root {
+  @include theme.theme(themes.$white);
+}
+// Set the <html> theme attribute to "g10" to use the Gray 10 theme
+// <html theme="g10">
+:root[storybook-carbon-theme='g10'] {
+  @include theme.theme(themes.$g10);
+}
+
+// Set the <html> theme attribute to "g90" to use the Gray 90 theme
+// <html theme="g90">
+:root[storybook-carbon-theme='g90'] {
+  @include theme.theme(themes.$g90);
+}
+
+// Set the <html> theme attribute to "g100" to use the Gray 100 theme
+// <html theme="g100">
+:root[storybook-carbon-theme='g100'] {
+  @include theme.theme(themes.$g100);
+}
+
+body {
+  background-color: theme.$background;
+  color: theme.$text-primary;
+}
+
+.sb-show-main.sb-main-padded {
+  padding: 0;
+}
+
+#main-content {
+  position: relative;
+  padding: 42px;
+}
+
+.#{$prefix}--content.#{$prefix}-ce-demo-devenv--ui-shell-content {
+  padding: 2rem;
+  margin: 0;
+  block-size: 100vh;
+  inline-size: 100%;
+}

package/.storybook/container.ts

@@ -0,0 +1,41 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2020, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { html, TemplateResult } from 'lit';
+import containerStyles from './_container.scss?lit';
+import '@carbon/web-components/es/components/skip-to-content/index.js';
+
+/**
+ * @param options The rendering options.
+ * @param [options.hasMainTag] `true` if the story itself has `<main>` tag.
+ * @param [options.children] The story content.
+ * @returns The content that wraps the story.
+ */
+const container = ({
+  hasMainTag,
+  children,
+}: {
+  hasMainTag?: boolean;
+  children: TemplateResult;
+}) => html`
+  <style>
+    ${containerStyles}
+  </style>
+  <!-- <cds-skip-to-content href="#main-content"></cds-skip-to-content> -->
+  <div
+    id="main-content"
+    name="main-content"
+    data-floating-menu-container
+    role="${hasMainTag ? 'none' : 'main'}"
+  >
+    ${children}
+  </div>
+`;
+
+export default container;

package/.storybook/main.ts

@@ -0,0 +1,25 @@
+import { mergeConfig } from 'vite';
+import { litStyleLoader, litTemplateLoader } from '@mordech/vite-lit-loader';
+import viteSVGResultCarbonIconLoader from '../tools/vite-svg-result-carbon-icon-loader';
+
+const config = {
+  stories: ['../src/**/*.stories.@(js|jsx|ts|tsx)'],
+  addons: ['@storybook/addon-links', '@storybook/addon-essentials'],
+  framework: {
+    name: '@storybook/web-components-vite',
+    options: {},
+  },
+  docs: {
+    autodocs: 'tag',
+  },
+  async viteFinal(config) {
+    return mergeConfig(config, {
+      plugins: [
+        litStyleLoader(),
+        litTemplateLoader(),
+        viteSVGResultCarbonIconLoader(),
+      ],
+    });
+  },
+};
+export default config;

package/.storybook/manager.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright IBM Corp. 2024, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { addons } from '@storybook/manager-api';
+import sbTheme from './theme';
+ 
+addons.setConfig({
+  theme: sbTheme,
+});

package/.storybook/preview-head.html

@@ -0,0 +1,3 @@
+<script>
+  window.global = window;
+</script>

package/.storybook/templates/with-layer.scss

@@ -0,0 +1,38 @@
+//
+// Copyright IBM Corp. 2019, 2023
+//
+// This source code is licensed under the Apache-2.0 license found in the
+// LICENSE file in the root directory of this source tree.
+//
+
+@use '@carbon/styles/scss/colors';
+@use '@carbon/styles/scss/theme';
+@use '@carbon/styles/scss/spacing';
+@use '@carbon/styles/scss/type';
+@use '@carbon/styles/scss/components/tag';
+
+@use '@carbon/styles/scss/config' as *;
+
+.#{$prefix}--with-layer__layer {
+  position: relative;
+  border: 1px dashed colors.$purple-50;
+}
+
+.#{$prefix}--with-layer__layer .#{$prefix}--with-layer__layer {
+  background-color: theme.$layer;
+  margin-block-start: spacing.$spacing-07;
+}
+
+.#{$prefix}--with-layer__label {
+  @include type.type-style('code-01');
+
+  display: inline-flex;
+  padding: spacing.$spacing-02;
+  background-color: tag.$tag-background-purple;
+  color: tag.$tag-color-purple;
+  column-gap: spacing.$spacing-02;
+}
+
+.#{$prefix}--with-layer__content {
+  padding: spacing.$spacing-05;
+}

package/.storybook/templates/with-layer.ts

@@ -0,0 +1,90 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2024, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { LitElement, html } from 'lit';
+import { customElement, property } from 'lit/decorators.js';
+import Layers from '@carbon/icons/lib/layers/16';
+import { prefix } from '../../src/globals/settings';
+
+import styles from './with-layer.scss?lit';
+
+/**
+ * Storybook template layer component, strictly for presentation purposes
+ *
+ * @element sb-template-layers
+ * @slot The elements contained within the component.
+ */
+@customElement(`sb-template-layers`)
+class CDSLayer extends LitElement {
+  @property()
+  content;
+
+  private _handleSlotChange({ target }: Event) {
+    if (!this.content) {
+      const content = (target as HTMLSlotElement)
+        .assignedNodes()
+        .filter(
+          (node) =>
+            node.nodeType !== Node.TEXT_NODE || node!.textContent!.trim()
+        );
+
+      this.content = content[0];
+    }
+  }
+
+  updated() {
+    if (this.content) {
+      const layer2 = this.content.cloneNode(true) as HTMLElement;
+      const layer3 = this.content.cloneNode(true) as HTMLElement;
+      layer2.setAttribute('slot', 'layer-2');
+      layer3.setAttribute('slot', 'layer-3');
+      this.appendChild(layer2);
+      this.appendChild(layer3);
+    }
+  }
+
+  render() {
+    return html`
+      <div class="${prefix}--with-layer">
+        <div class="${prefix}--with-layer__layer">
+          <div class="${prefix}--with-layer__label">${Layers()} Layer 1</div>
+          <div class="${prefix}--with-layer__content">
+            <cds-layer>
+              <slot @slotchange="${this._handleSlotChange}"></slot>
+              <div class="${prefix}--with-layer__layer">
+                <div class="${prefix}--with-layer__label">
+                  ${Layers()} Layer 2
+                </div>
+                <div class="${prefix}--with-layer__content">
+                  <cds-layer>
+                    <slot name="layer-2"></slot>
+                    <div class="${prefix}--with-layer__layer">
+                      <div class="${prefix}--with-layer__label">
+                        ${Layers()} Layer 3
+                      </div>
+                      <div class="${prefix}--with-layer__content">
+                        <cds-layer>
+                          <slot name="layer-3"></slot>
+                        </cds-layer>
+                      </div>
+                    </div>
+                  </cds-layer>
+                </div>
+              </div>
+            </cds-layer>
+          </div>
+        </div>
+      </div>
+    `;
+  }
+
+  static styles = styles;
+}
+
+export default CDSLayer;

package/.storybook/theme.ts

@@ -0,0 +1,12 @@
+import { create } from '@storybook/theming';
+import packageInfo from '../package.json';
+
+const { description, version } = packageInfo;
+
+export default create({
+  base: 'light',
+  brandTitle: `${description} v${version}`,
+  fontBase: "'IBM Plex Sans', 'Helvetica Neue', Arial, sans-serif",
+  fontCode: "'IBM Plex Mono', Menlo, 'DejaVu Sans Mono', Courier, monospace",
+  brandUrl: packageInfo.repository.url,
+});

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 IBM Corp.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.