feat(icon skeleton): storybook update (carbon-design-system#11442)

* feat(skeleton-icon): new cwc component (carbon-design-system#11434) ### Related Ticket(s) Closes carbon-design-system#11380 ### Description Adds new skeleton icon component ### Changelog **New** - skeleton icon readme, story, codesandbox examples         * feat(skeleton-icon): storybook v7 --------- Co-authored-by: kennylam <[email protected]>
kennylam · Jan 31, 2024 · 98cacbd · 98cacbd
1 parent 52a2391
commit 98cacbd
Show file tree

Hide file tree

Showing 30 changed files with 343 additions and 10 deletions.
diff --git a/packages/carbon-web-components/.storybook/main.ts b/packages/carbon-web-components/.storybook/main.ts
@@ -84,6 +84,8 @@ const stories = glob.sync(
     '../src/**/search.stories.ts',
     '../src/**/select.mdx',
     '../src/**/select.stories.ts',
+    '../src/**/skeleton-icon.mdx',
+    '../src/**/skeleton-icon.stories.ts',
     '../src/**/skeleton-placeholder.mdx',
     '../src/**/skeleton-placeholder.stories.ts',
     '../src/**/skeleton-text.mdx',

diff --git a/packages/carbon-web-components/README.md b/packages/carbon-web-components/README.md
@@ -119,6 +119,7 @@ These are the list of available components via CDN:
 - radio-button.min.js
 - search.min.js
 - select.min.js
+- skeleton-icon.min.js
 - skeleton-placeholder.min.js
 - skeleton-text.min.js
 - skip-to-content.min.js

diff --git a/packages/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/.babelrc b/packages/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/.babelrc
@@ -0,0 +1,22 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "modules": false,
+        "targets": [
+          "last 1 version",
+          "Firefox ESR",
+          "not opera > 0",
+          "not op_mini > 0",
+          "not op_mob > 0",
+          "not android > 0",
+          "not edge > 0",
+          "not ie > 0",
+          "not ie_mob > 0"
+        ]
+      }
+    ]
+  ],
+  "plugins": [["@babel/plugin-transform-runtime", { "version": "7.3.0" }]]
+}
diff --git a/...ages/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/.gitignore b/...ages/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/.gitignore
@@ -0,0 +1,22 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.cache
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/packages/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/.sassrc b/packages/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/.sassrc
@@ -0,0 +1,6 @@
+{
+  "includePaths": [
+    "node_modules",
+    "../../node_modules"
+  ]
+}
diff --git a/packages/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/cdn.html b/packages/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/cdn.html
@@ -0,0 +1,29 @@
+<!--
+@license
+
+Copyright IBM Corp. 2020
+
+This source code is licensed under the Apache-2.0 license found in the
+LICENSE file in the root directory of this source tree.
+-->
+
+<html>
+<head>
+  <title>@carbon/ibmdotcom-web-components example</title>
+  <meta charset="UTF-8"/>
+  <link rel="stylesheet"
+        href="https://1.www.s81c.com/common/carbon-for-ibm-dotcom/tag/v1/latest/plex.css"/>
+  <link rel="stylesheet" href="https://1.www.s81c.com/common/carbon/web-components/tag/v2/latest/grid.css" />
+  <link rel="stylesheet" href="https://1.www.s81c.com/common/carbon/web-components/tag/v2/latest/themes.css" /> 
+  <style>
+    /* Suppress custom element until styles are loaded */
+    cds-skeleton-icon:not(:defined) {
+      display: none;
+    }
+  </style>
+  <script type="module" src="https://1.www.s81c.com/common/carbon/web-components/tag/v2/latest/skeleton-icon.min.js"></script>
+</head>
+<body class="cds-theme-zone-white">
+  <cds-skeleton-icon></cds-skeleton-icon>
+</body>
+</html>
diff --git a/...ages/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/index.html b/...ages/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/index.html
@@ -0,0 +1,28 @@
+<!--
+@license
+
+Copyright IBM Corp. 2020
+
+This source code is licensed under the Apache-2.0 license found in the
+LICENSE file in the root directory of this source tree.
+-->
+
+<html>
+<head>
+  <title>carbon-web-components example</title>
+  <meta charset="UTF-8" />
+  <link rel="stylesheet"
+        href="https://1.www.s81c.com/common/carbon-for-ibm-dotcom/tag/v1/latest/plex.css"/>
+  <link rel="stylesheet" href="src/styles.scss" />
+ <style>
+    /* Suppress custom element until styles are loaded */
+    cds-skeleton-icon:not(:defined) {
+      display: none;
+    }
+  </style>
+  <script type="module" src="src/index.js"></script>
+</head>
+<body>
+  <cds-skeleton-icon></cds-skeleton-icon>
+</body>
+</html>
diff --git a/...es/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/package.json b/...es/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/package.json
@@ -0,0 +1,23 @@
+{
+  "name": "carbon-web-components-skeleton-icon-example",
+  "version": "0.1.0",
+  "private": true,
+  "description": "Sample project for getting started with the Web Components from Carbon.",
+  "license": "Apache-2",
+  "main": "index.html",
+  "scripts": {
+    "build": "parcel build *.html --no-minify --public-url ./",
+    "clean": "rimraf node_modules dist .cache",
+    "start": "parcel index.html --port=9000 --no-hmr"
+  },
+  "dependencies": {
+    "@carbon/styles": "^1.34.0",
+    "@carbon/web-components": "latest",
+    "sass": "^1.64.1"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.0.0-0",
+    "parcel-bundler": "1.12.3",
+    "rimraf": "^3.0.2"
+  }
+}
diff --git a/...on-web-components/examples/codesandbox/basic/components/skeleton-icon/sandbox.config.json b/...on-web-components/examples/codesandbox/basic/components/skeleton-icon/sandbox.config.json
@@ -0,0 +1,3 @@
+{
+  "template": "node"
+}
diff --git a/...es/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/src/index.js b/...es/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/src/index.js
@@ -0,0 +1,10 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2020, 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 '@carbon/web-components/es/components/skeleton-icon/index.js';
diff --git a/...carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/src/styles.scss b/...carbon-web-components/examples/codesandbox/basic/components/skeleton-icon/src/styles.scss
@@ -0,0 +1,18 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 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/scss/reset';
+@use '@carbon/styles/scss/theme';
+@use '@carbon/styles/scss/themes';
+
+:root {
+  @include theme.theme(themes.$white);
+  background-color: var(--cds-background);
+  color: var(--cds-text-primary);
+}
diff --git a/packages/carbon-web-components/src/components/button/button.mdx b/packages/carbon-web-components/src/components/button/button.mdx
@@ -1,7 +1,10 @@
-import { ArgsTable, Description } from '@storybook/addon-docs/blocks';
+import { ArgsTable, Markdown, Meta } from '@storybook/addon-docs/blocks';
 import { cdnJs, cdnCss } from '../../globals/internal/storybook-cdn';
 import Add16 from '@carbon/web-components/es/icons/add/16';
+import * as ButtonStories from './button.stories';
 
+<Meta of={ButtonStories} />
+
 # Button
 
 > 💡 Check our

diff --git a/packages/carbon-web-components/src/components/data-table/stories/data-table.mdx b/packages/carbon-web-components/src/components/data-table/stories/data-table.mdx
@@ -1,5 +1,8 @@
-import { ArgsTable, Markdown } from '@storybook/addon-docs/blocks';
+import { ArgsTable, Markdown, Meta } from '@storybook/addon-docs/blocks';
 import { cdnJs, cdnCss } from '../../../globals/internal/storybook-cdn';
+import * as DataTable from './data-table-basic.stories';
+
+<Meta of={DataTable} />
 
 # Data table
 

diff --git a/packages/carbon-web-components/src/components/list/list.mdx b/packages/carbon-web-components/src/components/list/list.mdx
@@ -1,5 +1,8 @@
 import { ArgsTable, Markdown, Meta } from '@storybook/addon-docs/blocks';
 import { cdnJs, cdnCss } from '../../globals/internal/storybook-cdn';
+import * as OrderedListStories from './ordered-list.stories';
+
+<Meta of={OrderedListStories} />
 
 # List
 

diff --git a/packages/carbon-web-components/src/components/notification/notification.mdx b/packages/carbon-web-components/src/components/notification/notification.mdx
@@ -1,8 +1,11 @@
 import {
   ArgsTable,
-  Markdown
+  Markdown, Meta
 } from '@storybook/addon-docs/blocks';
 import { cdnJs, cdnCss } from '../../globals/internal/storybook-cdn';
+import * as ActionableNotification from './actionable-notification.stories';
+
+<Meta of={ActionableNotification} />
 
 # Notification
 

diff --git a/packages/carbon-web-components/src/components/skeleton-icon/docs/overview.mdx b/packages/carbon-web-components/src/components/skeleton-icon/docs/overview.mdx
@@ -0,0 +1,12 @@
+## Live demo
+
+<StorybookDemo
+  tall
+  url="https://www.ibm.com/standards/carbon/carbon-web-components"
+  variants={[
+    {
+      label: 'Default',
+      variant: 'components-skeleton-icon--default'
+    }
+  ]}
+/>
diff --git a/packages/carbon-web-components/src/components/skeleton-icon/index.ts b/packages/carbon-web-components/src/components/skeleton-icon/index.ts
@@ -0,0 +1,10 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2021, 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 './skeleton-icon';
diff --git a/packages/carbon-web-components/src/components/skeleton-icon/skeleton-icon.mdx b/packages/carbon-web-components/src/components/skeleton-icon/skeleton-icon.mdx
@@ -0,0 +1,36 @@
+import { ArgsTable, Meta, Markdown } from '@storybook/addon-docs/blocks';
+import { cdnJs, cdnCss } from '../../globals/internal/storybook-cdn';
+import * as SkeletonIconStories from './skeleton-icon.stories';
+
+<Meta of={SkeletonIconStories} />
+
+# Skeleton icon
+
+> 💡 Check our
+> [CodeSandbox](https://codesandbox.io/s/github/carbon-design-system/carbon-for-ibm-dotcom/tree/main/packages/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon)
+> example implementation.
+
+[![Edit carbon-web-components](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/carbon-design-system/carbon-for-ibm-dotcom/tree/main/packages/carbon-web-components/examples/codesandbox/basic/components/skeleton-icon)
+
+## Getting started
+
+Here's a quick example to get you started.
+
+### JS (via import)
+
+```javascript
+import '@carbon/web-components/es/components/skeleton-icon/index.js';
+```
+
+<Markdown>{`${cdnJs({ components: ['skeleton-placeholder'] })}`}</Markdown>
+<Markdown>{`${cdnCss()}`}</Markdown>
+
+### HTML
+
+```html
+<cds-skeleton-icon></cds-skeleton-icon>
+```
+
+## `<cds-skeleton-icon>` attributes, properties and events
+
+<ArgsTable of="cds-skeleton-icon" />
diff --git a/packages/carbon-web-components/src/components/skeleton-icon/skeleton-icon.scss b/packages/carbon-web-components/src/components/skeleton-icon/skeleton-icon.scss
@@ -0,0 +1,16 @@
+//
+// Copyright IBM Corp. 2019, 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/scss/config' as *;
+@use '@carbon/styles/scss/components/skeleton-styles';
+@use '@carbon/styles/scss/utilities/skeleton' as *;
+
+:host(#{$prefix}-skeleton-icon) {
+  @include skeleton;
+
+  @extend .#{$prefix}--icon--skeleton;
+}
diff --git a/packages/carbon-web-components/src/components/skeleton-icon/skeleton-icon.stories.ts b/packages/carbon-web-components/src/components/skeleton-icon/skeleton-icon.stories.ts
@@ -0,0 +1,34 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2019, 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 { html } from 'lit';
+import './skeleton-icon';
+import storyDocs from './skeleton-icon.mdx';
+
+export const Default = {
+  parameters: {
+    percy: {
+      skip: true,
+    },
+  },
+  render: () => html`<cds-skeleton-icon style="margin: 50px"></cds-skeleton-icon
+    ><cds-skeleton-icon
+      style="margin: 50px; width: 24px; height: 24px;"></cds-skeleton-icon>`,
+};
+
+const meta = {
+  title: 'Components/Skeleton/Skeleton Icon',
+  parameters: {
+    docs: {
+      page: storyDocs,
+    },
+  },
+};
+
+export default meta;
diff --git a/packages/carbon-web-components/src/components/skeleton-icon/skeleton-icon.ts b/packages/carbon-web-components/src/components/skeleton-icon/skeleton-icon.ts
@@ -0,0 +1,25 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2019, 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 } from 'lit';
+import { prefix } from '../../globals/settings';
+import styles from './skeleton-icon.scss?lit';
+import { carbonElement as customElement } from '../../globals/decorators/carbon-element';
+
+/**
+ * Skeleton icon.
+ *
+ * @element cds-skeleton-icon
+ */
+@customElement(`${prefix}-skeleton-icon`)
+class CDSSkeletonIcon extends LitElement {
+  static styles = styles;
+}
+
+export default CDSSkeletonIcon;
diff --git a/packages/carbon-web-components/src/components/structured-list/structured-list.mdx b/packages/carbon-web-components/src/components/structured-list/structured-list.mdx
@@ -1,6 +1,8 @@
-import { ArgsTable, Description } from '@storybook/addon-docs/blocks';
+import { ArgsTable, Description, Meta } from '@storybook/addon-docs/blocks';
 import { cdnJs, cdnCss } from '../../globals/internal/storybook-cdn';
+import * as StructuredList from './structured-list.stories';
 
+<Meta of={StructuredList} />
 # Structured list
 
 > 💡 Check our

diff --git a/packages/carbon-web-components/src/components/tabs/tabs.mdx b/packages/carbon-web-components/src/components/tabs/tabs.mdx
@@ -1,5 +1,8 @@
-import { ArgTypes, Markdown } from '@storybook/addon-docs/blocks';
+import { ArgTypes, Markdown, Meta } from '@storybook/addon-docs/blocks';
 import { cdnJs, cdnCss } from '../../globals/internal/storybook-cdn';
+import * as TabsStories from './tabs.stories';
+
+<Meta of={TabsStories} />
 
 # Tabs