@trumpetstech/bootwind
v1.0.7
Published
Utility and component-centric design system based on Bootstrap for fast, responsive UI development.
Downloads
9
Maintainers
Readme
Install via npm
For most projects (and to take advantage of the customization features), you'll want to install Bootwind CSS and its peer-dependencies via npm.
npm install @trumpetstech/bootwind@latest bootstrap@latest --save-dev
This will automatically install the latest Bootstrap version, so you don't need to do that manually.
Create the Sass files
In your scss
folder create two new files and name them:
- main.scss
- utility.scss
Import the base styles and components
In your main.scss, you’ll import the source Sass files. Bootstrap is automatically loaded when you use the source files, so you don't need to worry about what Bootstrap files should you incorporate in your styles.
@import "@trumpetstech/bootwind/base";
@import "@trumpetstech/bootwind/forms";
// Load all the components
@import "@trumpetstech/bootwind/components";
or pick the parts you need:
@import "@trumpetstech/bootwind/base";
@import "@trumpetstech/bootwind/forms";
// Load only the components you use
@import "@trumpetstech/bootwind/components/alerts";
@import "@trumpetstech/bootwind/components/avatars";
@import "@trumpetstech/bootwind/components/buttons";
@import "@trumpetstech/bootwind/components/navbars";
@import "@trumpetstech/bootwind/components/cards";
Click here to see the complete list of available components.
Import the utility classes
In Bootwind CSS you'll notice that we don't create custom styles, but rather make use of the utility classes. We are using the new Bootstrap Utility API to generate a comprehensive list of classes.
In your utility.scss you'll import all the utilities:
@import "@trumpetstech/bootwind/utilities";
Integrations
If you want to see how it works, check out these functional examples of using Bootstrap and Bootwind CSS in common JS frameworks like Webpack, Parcel, Vite, and more!
Thank you
License
Made with ❤️ by Trumpets. Bootwind CSS is open-sourced software licensed under the MIT license.