@devboldly/react-bootswatch-select v0.0.2

Documentation

Read the official documentation.

Overview

Drop a Bootswatch theme selector onto your React site with just one line!

This package includes three components:

• BootswatchSelect - A Bootswatch theme selector that supports two modes: visible and hidden.
• Bootstrap - A component for easily adding Bootstrap to your site, for convenience.
• FontAwesome - A component for easily adding Font Awesome to your site, for convenience.

By default, all CSS is loaded from bootstrapcdn.com.

Features include:

• 🎨 Easily try Bootswatch themes
  • Want to quickly skin your Bootstrap site? Drop this component in and try out Bootswatch with one line!
• 🌠 Build beautiful prototypes quickly
  • Quickly swatch out your next big project so you can focus on the stuff that matters.
• 📨 Quickly drop in Bootstrap and Font Awesome
  • For convenience, Bootstrap and Font Awesome CDN components are included to get you up and running fast.

Demo

Installation

npm i @devboldly/react-bootswatch-select

Quick Start

If Bootstrap is loaded already:

Selector Visible

import { BootswatchSelect } from '@devboldly/react-bootswatch-select';
...
<BootswatchSelect version={'4.4.1'} className="form-control" />

Selector Hidden

import { BootswatchSelect } from '@devboldly/react-bootswatch-select';
...
<BootswatchSelect version={'4.4.1'} selectedThemeName="cerulean" selectorHidden />

Bootstrap + Bootswatch

If you'd like to load Bootstrap (or Font Awesome) from the CDN before the BootswatchSelect is used:

import { Bootstrap, FontAwesome, BootswatchSelect } from '@devboldly/react-bootswatch-select';
...
<Bootstrap version={'4.4.1'} />
<FontAwesome version={'4.7.0'} />
<BootswatchSelect version={'4.4.1'} className="form-control" />

All CSS is loaded from bootstrapcdn.com by default.

Font Awesome is not required for BootswatchSelect, but is included here in case you want it.

Contributing

Open source software is awesome and so are you. 😎

Feel free to submit a pull request for bugs or additions, and make sure to update tests as appropriate. Even the smallest changes help.

For major changes, open an issue first to discuss what you'd like to change.

⭐ Found It Helpful? Star It!

More stars means more development love. So if you found this project helpful, star it! 👉⭐

License

This project is covered under the MIT License:

Copyright © 2020 DevBoldly https://devboldly.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.