drab focuses on providing JavaScript functionality where it's most useful. Many of the components are helpful wrappers around browser APIs. Whenever possible, components are progressively enhanced or provide a fallback noscript message. Additionally, transitions are disabled for users who prefer reduced motion.
This library takes a more opinionated approach compared to some headless UI libraries by providing the basic HTML structure for every component, as well as default positioning for elements like the sheet. However, these components can still be further customized using styles, slots, and slot props.
Components without styles can appear rather drab. You have the freedom to bring your own styles to these components! Using unstyled components allows you to selectively choose what you need, seamlessly integrate with existing designs, and avoid being tied to any specific library.
To style the components, you can make use of global styles. Each component exports class and id props that can be leveraged for this purpose. This process can be expedited by utilizing CSS frameworks like TailwindCSS. Tailwind generates a global stylesheet based on the utility classes used in your project. The examples in this documentation are styled with Tailwind classes, but Tailwind does not have to be used with this library.
If you haven't used Svelte before, start with the tutorial. drab works anywhere Svelte does.
npm install -D drabThe library provides inline documentation for each component, allowing you to conveniently access the documentation by hovering over the component in your text editor after importing it. Additionally, every prop is documented using JSDoc and TypeScript. By hovering over a prop, you can retrieve its type and description.
These docs use the TailwindCSS Typography plugin for base styles along with a few custom utility classes you can find here. Styles on this site are based on shadcn/ui.
If drab isn't what you are looking for, here are some other Svelte UI libraries to check out.
Find an bug or have an idea? Feel free to create an issue on GitHub. drab is meant to house all kinds of components including ones outside of the standard UI elements.
Currently, drab has only one dependency - Svelte. Not to say it will never have another, but please consider this when adding in additional functionality. drab is meant to make the web platform easier to use with Svelte.
Since this is an unstyled library, simple components like a badge that can be easily created with HTML and CSS are not included.
Contribute to the project, or use drab as a template for another component library. This library is built with SvelteKit, TypeScript, and npm. The package contents are located in src/lib, the site is contained within src/routes and src/site. The site is deployed to Vercel using @sveltejs/adapter-vercel. If you are using this project as a template, be sure to update the adapter based on how you deploy.
- Clone the repository
npm installnpm run dev -- --open
- Add or edit the component in
src/lib/components/Component.svelte- if you're adding a new one, copy and paste an existing one to get started with the conventions - Add or edit the example in
src/routes/docs/Component/+page.svelte - Document the component with an
@componentcomment, include a description, and the@slotsavailable. Add a placeholder@propsand@exampleto the comment. These sections will be generated based on the JSDoc comment above each prop and the example route upon runningnpm run doc - If new, add the link to
src/site/components/NavItems.svelte - Run
npm run buildto verify your build