https://github.com/N00nDay/stwui

Opinionated yet customizable Svelte-TailwindCSS component library
https://github.com/N00nDay/stwui

components svelte svelte-components svelte3 sveltejs tailwindcss

Last synced: 3 months ago
JSON representation

Opinionated yet customizable Svelte-TailwindCSS component library

• Host: GitHub
• URL: https://github.com/N00nDay/stwui
• Owner: N00nDay
• License: mit
• Created: 2022-09-29T12:45:16.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-11T14:34:41.000Z (8 months ago)
• Last Synced: 2024-04-23T21:25:23.587Z (7 months ago)
• Topics: components, svelte, svelte-components, svelte3, sveltejs, tailwindcss
• Language: Svelte
• Homepage: stwui.vercel.app
• Size: 5.58 MB
• Stars: 424
• Watchers: 7
• Forks: 19
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        




[![Under Development](https://img.shields.io/badge/under-development-orange.svg)](https://stwui.vercel.app/) [![npm version](https://img.shields.io/npm/v/stwui?logo=npm&color=cb3837)](https://www.npmjs.com/package/stwui) [![Chat](https://img.shields.io/discord/1003691521280856084?label=chat&logo=discord&color=7289da)](https://discord.gg/YVgwp48Tcm) [![license](https://img.shields.io/badge/license-MIT-%23bada55)](https://github.com/N00nDay/stwui/blob/main/LICENSE)

Svelte-TailwindCSS UI (STWUI) is currently in pre-release. There has been a lot work already but a lot of work still needs to be done. Most of my inspiration comes from TawilwindUI with a desire to create a component library similar to React component libraries that are less reliant on remembering class names. Contributors and collaborators welcome!







A showcase can be found at [https://stwui.vercel.app/](https://stwui.vercel.app/). Documentation is still forthcoming but you can at least see the components being used.

# Installing

- Run `npm install stwui`

- Add `require('stwui/plugin')` to the `plugins` section of your `tailwind.config.cjs`

- Add `'./node_modules/stwui/**/*.{svelte,js,ts,html}'` to the `content` array of your `tailwind.config.cjs`

```

module.exports = {

	content: [

		'./src/**/*.{html,js,svelte,ts}',

		'./node_modules/stwui/**/*.{svelte,js,ts,html}'

	],

	plugins: [

		require('@tailwindcss/forms'),

		require('stwui/plugin')

	]

};

```

# How to Contribute

- Clone the project to your local machine: ``git clone [email protected]:N00nDay/stwui.git MY-PROJECT-NAME && cd MY-PROJECT-NAME``

- Install dependancies with ``npm install``

- Start your dev server with ``npm run dev``

- Make changes, and submit your pull request.

📖 The docs are included in this repo which is itself a SvelteKit app. You'll find the pages for each component within `src/routes/`.

## Useful Resources

* [Contribution Guide](https://github.com/N00nDay/stwui/tree/main/.github/CONTRIBUTING.md)

* [Code of Conduct](https://github.com/N00nDay/stwui/tree/main/.github/CODE_OF_CONDUCT.md)

## Contributors

Craig Howell N00nDay https://github.com/N00nDay