Skip to content

Latest commit

 

History

History
95 lines (55 loc) · 4.83 KB

readme.md

File metadata and controls

95 lines (55 loc) · 4.83 KB

Github release Github release code style: prettier Getting Started

SDDS - Components


Deprecation Notice

This package has been deprecated and is no longer actively maintained.

Why is this package deprecated?

This package has reached the end of its development lifecycle, and we have decided to discontinue active support and updates for it. We recommend that you consider alternative solutions for your project to ensure ongoing compatibility, security, and stability.

Recommended Alternatives

We suggest exploring the Tegel Design System, which is the successor of SDDS and is actively maintained:

  • @scania/tegel: One package for the entire Tegel design system. Based on Web Components.
  • @scania/tegel-react: Version of @scania/tegel that provides React component wrappers.
  • @scania/tegel-angular: Version of @scania/tegel that provides Angular component wrappers.

What should you do now?

  1. Migrate to an alternative package: We strongly encourage you to transition to one of the recommended alternatives mentioned above by following their documentation and migration guides on npm, SDDS -> TDS migration guide and Tegel installation on the official Tegel website.

  2. Remove the deprecated package: You can safely remove this package from your project once you have successfully migrated to an alternative solution.

Thank You!

We appreciate your support and use of this package. If you have any questions or need further assistance with the deprecation process or migration, feel free to reach out to us by creating an issue in our GitHub repository or contacting Development support channel in Teams.

Again, thank you for being a part of our community, and we hope the recommended alternatives serve your needs effectively.

*Last Updated: October 23rd 2023


Technical documentation

Check out our official Tegel Design System page for implementation and technical documentation.

Quick start

How to add components in the project:

Install components via NPM package by running the command below.

npm i @scania/components

Import component as a module with defineCustomElements function.

import { defineCustomElements } from '@scania/components';

defineCustomElements();

See all available components in the Tegel Design System.

Styling

To apply Scania styles, you need to add a theme package and use sdds-theme component. Check out Scania theme documentation for detail documentation.

Browser support

  • Chrome
  • Firefox
  • Safari
  • Edge (chromium)

The components are not supported in IE11 & Edge Legacy

Contributing

Please read through our contributing guidelines for the directions to develop components, create a pull request and coding standard.

Community

Get in touch with the team and the community:

License

All CSS, HTML and JS code are available under the MIT license. The Scania brand identity, logos and photographs found in this repository are copyrighted Scania CV AB and are not available on an open source basis or to be used as examples or in any other way, if not specifically ordered by Scania CV AB.