kudu-ui-system

0.1.22 • Public • Published

Kudu UI System

Kudu UI Design System is a CSS library used across all products developed by Kudu.

npm version

Install package

Note:

In order to the kudu-ui-system package to work correctly, you need to have Tailwind and PostCSS configured in your project beforehand. You can learn how to configure Tailwind and PostCSS in your project by following this link.

After installing ppnpm, Tailwind and PostCSS, you can install kudu-ui-system with this command:

pnpm i kudu-ui-system

Usage

  1. Import and include the preset configuration from kudu-ui-system in your tailwind.config.js.
const { tailwindPreset } = require("kudu-ui-system/tailwindcss");

/** @type {import('tailwindcss').Config} */
export default {
  content: ["./src/**/*.{html,js,svelte,ts}"],
  presets: [tailwindPreset],
};
  1. Import and include the postcss configuration from kudu-ui-system in your postcss.config.js.
const { kuduuisystem } = require("kudu-ui-system/postcss");

export default {
  plugins: {
    ...kuduuisystem,
    ...
  }
};
  1. In your main CSS file, import kudu-ui-system at the beginning of the file
@import "kudu-ui-system/styles";
  1. Set the custom atrribute data-theme="kududesign" in your HTML file:
<!DOCTYPE html>
<html lang="en" dir="ltr" data-theme="kududesign">
  ...
</html>

Development

All this package is generated with Tailwind CSS and DaisyUI.

Tailwind CSS allows for more efficient CSS writing and maintains a structured approach. Daisy UI is a class library that provides styles for commonly used components.

For more details, you can refer to the documentation of Tailwind CSS and Daisy UI.

Changelog

If you want to know the different changes between versions of this package, look at the changelog here.

I have an issue, what should I do?

Please file the issue here.

Contributing

See the contributing docs.

License

By contributing to kudu-ui-system, you agree that your contributions will be licensed under the LICENSE of the project.

Package Sidebar

Install

npm i kudu-ui-system

Weekly Downloads

1

Version

0.1.22

License

GNU GPL

Unpacked Size

47.1 kB

Total Files

17

Last publish

Collaborators

  • kuduconsultant