Skip to content

Design system supported by tailwindcss library, it allows the creation of applications supporting light and dark themes, shares UI React Components and a color palette in compliance with the Szum-Tech standards.

License

Notifications You must be signed in to change notification settings

JanSzewczyk/design-system

Repository files navigation

@szum-tech/design-system

Szum-Tech design system.


GitHub Release GitHub pull requests GitHub issues Github stars
Publish action CodeQL action
NPM version Downloads

Design system supported by Tailwind CSS library, it allows the creation of applications supporting light and dark themes, shares UI React Components and a color palette in compliance with the Szum-Tech standards.


πŸ“š Features

πŸ“– Table of Contents

🎯 Getting Started

βš™οΈ Installation

@szum-tech/design-system is available as npm package,

Install tailwindcss and @szum-tech/design-system via npm.

# NPM
npm install tailwindcss @szum-tech/design-system

# YARN
yarn add tailwindcss @szum-tech/design-system

# PNPM
pnpm add tailwindcss @szum-tech/design-system

# BUN
bun add tailwindcss @szum-tech/design-system

Tailwindcss Configuration

To configure Tailwind CSS, follow the Installation section in the Tailwind CSS documentation.

On this page, you can find all the necessary information for integrating Tailwind in various ways - you can choose the one that suits you best.

CSS file

Add the following lines to your CSS file:

@import "tailwindcss";

/* Use the @import directive to inline import CSS file with predefined styles */
@import "@szum-tech/design-system/tailwind/global.css";

/* Use the @source directive to explicitly specify source files that aren't picked up by Tailwind's automatic content detection */
@source "../node_modules/@szum-tech/design-system";

Usage

Components

All components of the design system, context, hooks, functions, etc., are imported from @szum-tech/design-system

import { Button } from "@szum-tech/design-system";

Icons

To use Icons you need to import them from @szum-tech/design-system/icons

import { GoogleLogoIcon } from "@szum-tech/design-system/icons";

πŸ› οΈ Developer Info

Dependencies

NPM (prod) Dependency Version NPM (prod) Dependency Version NPM (prod) Dependency Version NPM (prod) Dependency Version NPM (prod) Dependency Version

Peer Dependencies

NPM dev or peer Dependency Version NPM dev or peer Dependency Version NPM dev or peer Dependency Version NPM dev or peer Dependency Version

Documentation

Szum-Tech Design System

πŸ““ Changelog

The changelog is regularly updated to reflect what's changed in each new release.

πŸ“œ License

This project is licensed under the terms of the MIT license.

About

Design system supported by tailwindcss library, it allows the creation of applications supporting light and dark themes, shares UI React Components and a color palette in compliance with the Szum-Tech standards.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •