npm

stwui
TypeScript icon, indicating that this package has built-in type declarations

0.21.2-next • Public • Published

Under Development npm version Chat 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/. 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 git@github.com: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

Contributors

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

Package Sidebar

Install

npm i stwui

Weekly Downloads

193

Version

0.21.2-next

License

MIT

Unpacked Size

925 kB

Total Files

683

Last publish

Collaborators

  • noonday