XUI REACT

This is a component library that utilizes Shadcn and TailwindCSS for styling.

XUI REACT

• Installation
• Usage
• Themes
• Providers
  • XThemeProvider
  • XSpinnerProvider
• Hooks
  • UseXTheme

Installation

To use this library, first install it via npm or yarn:

npm install @ximdex/xui-react@latest
# or
yarn add @ximdex/xui-react@latest

Usage

Importing Styles

Make sure to import the base styles into your project. Add the following line below your main CSS import:

@import "@ximdex/xui-react/dist/css/base.css";

You can use two themes:

• Ximdex Theme
• EU Theme

For use components:

• Components
  • XNav
  • XButton
  • XInput
  • XDropdown
  • XSwitch
  • XList
  • XLabel
  • XSpinner
  • XCalendar
  • XContainerPage
  • XContainerSidebar
  • XContainerContent
  • XCard
  • XTitlebar
  • XTabs
  • XTag
  • XRadio
  • XDateRangeCalendar
  • XNavigation

Publishing the next version of the npm package

1. Change version number on package.json.
2. Run npm run build:npm.
3. Login on npm with npm login.

Post npm publish

To keep track of the changes within versions make sure to do the following:

1. Go to the releases page within the github repository.
2. Click on Draft a new release
3. Create a new tag. (Example format: v0.6.4)
4. Enter a new title. (Example format: 0.6.4)
5. Write a description of what this new version does.
6. Make sure Set as the latest release is selected.
7. Click on Publish release at the bottom of the page.

Notes

• Ensure TailwindCSS is correctly configured in your project.
• Theming works by layering styles, so always include base.css before applying a theme.

For further documentation, refer to the official docs of this component library.