search

kyndryl-design-system / shidoka-applications

Web Components for Applications
https://shidoka-applications.netlify.app
MIT License
8 stars 0 forks source link

readme

Shidoka Web Components for Applications

shidoka-applications

Contributing

Read the Contributing Guide here.

Usage

Install

npm install @kyndryl-design-system/shidoka-applications @kyndryl-design-system/shidoka-foundation -S

Import the root stylesheets to your app's global styles

The method used (SCSS @use, CSS @import, JS import, or <style> tag) will vary based on your framework/bundler. Some examples:

SCSS

@use '~@kyndryl-design-system/shidoka-foundation/scss/root.scss';
@use '~@kyndryl-design-system/shidoka-applications/common/scss/root.scss';

CSS

@import '@kyndryl-design-system/shidoka-foundation/css/root.css';
@import '@kyndryl-design-system/shidoka-applications/common/css/root.css';

JS

import '@kyndryl-design-system/shidoka-foundation/css/root.css';
import '@kyndryl-design-system/shidoka-applications/common/css/root.css';

Use CSS tokens/variables

After installation, you can make use of tokens/variables included in root.css such as the color tokens.

Start using components

See Storybook for the full components documentation.

Example: Component with Sub-components

This example imports the Header component AND all of it's subcomponents by targeting the index file.

import '@kyndryl-design-system/shidoka-applications/components/global/header';
<kyn-header>
  <kyn-header-nav>
    <kyn-header-link>Link</kyn-header-link>
  </kyn-header-nav>
</kyn-header>

Example: Single Component

This example imports the HeaderLink component by targeting the component file directly.

import '@kyndryl-design-system/shidoka-applications/components/global/header/headerLink';
<kyn-header-link>Link</kyn-header-link>

React usage

React 19 has introduced native support for Custom Elements.

Older versions of React do not support automatic interop with Custom Elements. This means that React treats all props passed to Web Components as string attributes. Until you've upgraded to React 19+, you will need to use a library like @lit/react or reactify-wc to wrap these components for use in React.

Server-Side Rendering (SSR)

When using with an SSR framework like Next.js, you will encounter errors with code that only runs client-side, like window references for example. This is because web components cannot render on the server. Here is an article that provides some methods to work around this: Using Non-SSR Friendly Components with Next.js and How to entirely disable server-side rendering in next.js v13?. Basically, web components need their rendering deferred to only happen on the client-side.

Here is some additional information about why SSR does not work for web components, and some potential polyfills/solutions to enable server rendering: https://lit.dev/docs/ssr/overview/

Handling Failed to execute 'define' on 'CustomElementRegistry'

The Problem

This is a common bundling issue that can appear when you incorporate a component that has already bundled Shidoka components. Typically this would be caused by having a middle layer, for example a Common UI layer that has a cross-platform Header component built using Shidoka components.

Avoiding This

You can get around this in by not declaring Shidoka components as dependencies, and instead declaring them as external or peer dependencies in the middle/common layer.

For example, from the shidoka-applications rollup.js config using the external option: external: [/shidoka-foundation\/components/]. Since shidoka-foundation components are used within shidoka-applications components, this prevents the foundation components from being bundled, meaning it leaves the import statements unaltered (ex: import '@kyndryl-design-system/...'). This way, the application bundler can handle it instead.

This works with bundling from node_modules, but not with CDN hosted files since the deployed application won't know how to resolve aliased node_modules imports ex: import '@kyndryl-design-system/...'. In this case, you probably need a workaround.

Workaround

If for some reason the above suggestion does not help, there is a library containing a script/polyfill that can be used which allows custom elements to be redefined: https://github.com/caridy/redefine-custom-elements. We've found that this script works best when served from the app's <head> tag.