diff --git a/README.md b/README.md new file mode 100644 index 0000000..edf9ee5 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# BSFormControls4 + +> BSFormControls4 is a small collection of form controls for Bootstrap 4. This is implemented purely with CSS. Bootstrap 4 is not actually required. + +--- + +## Features + +- Horizontal toggle switch (checkbox) +- Checkbox + +## Screenshots + +[](wiki/screenshot-1.png) + +--- + +## Releases & Builds + +See [Releases](/Ray/bsformcontrols4/releases) + +## Documentation + +See [Usage](wiki/USAGE.md) + +## Acknowledgements + +This software uses a number of dependencies and assets from third-parties. +These developers and artists deserve due credit for their work and for their commitment to sharing their work freely. +Each product is released under their own particular license, for more information please visit their websites. + +- [Bootstrap](https://getbootstrap.com/) + +## License + +This project is licensed under the least restrictive terms of its dependencies, viz. MIT License. \ No newline at end of file diff --git a/wiki/USAGE.md b/wiki/USAGE.md new file mode 100644 index 0000000..d8396a4 --- /dev/null +++ b/wiki/USAGE.md @@ -0,0 +1,101 @@ +# Usage: v1.0.0.066 + +This is the usage guide for [BSFormControls4](/bootstrap-bsformcontrols4), version 1.0.0.066. + +## Usage + +### Horizontal toggle switch + +This horizontally-oriented toggle switch is actually just a checkbox. You can apply stock BS4 colours to the on and off positions using the classes below. + +#### Colour Options + +CSS class for colour in the off position: **switch-off-primary**, **switch-off-success**, **switch-off-info**, **switch-off-warning**, **switch-off-danger** and **switch-off-muted**. + +CSS class for colour in the on position: **switch-primary**, **switch-success**, **switch-info**, **switch-warning**, **switch-danger** and **switch-muted**. + +#### Size Options + +We have the standard set of size options: **switch-sm**, **switch-md** and **switch-lg**. + +#### Example + +```html +