Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sbuttons/sbuttons
:bulb: Simple buttons you can use easily for your next project.
https://github.com/sbuttons/sbuttons
animation button-animation button-css buttons css css-animation css3 hacktoberfest less lesscss stylesheet
Last synced: about 18 hours ago
JSON representation
:bulb: Simple buttons you can use easily for your next project.
- Host: GitHub
- URL: https://github.com/sbuttons/sbuttons
- Owner: sButtons
- License: mit
- Archived: true
- Created: 2018-11-27T14:36:30.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-28T16:51:31.000Z (almost 2 years ago)
- Last Synced: 2024-09-24T19:39:11.298Z (about 18 hours ago)
- Topics: animation, button-animation, button-css, buttons, css, css-animation, css3, hacktoberfest, less, lesscss, stylesheet
- Language: Less
- Homepage: https://sbuttons.netlify.app/
- Size: 16.3 MB
- Stars: 404
- Watchers: 15
- Forks: 559
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
> :warning: This repository is now archived as I'm unable to maintain it moving forward. Thank you for everyone that contributed to this project!
Logo made by [Harshit Sharma](https://www.github.com/icoderharshit)
[](./LICENSE)
[](https://github.com/sButtons/sbuttons/actions/workflows/codeql-analysis.yml) [](https://badge.fury.io/js/sbuttons) [](https://www.jsdelivr.com/package/npm/sbuttons)
[](./CONTRIBUTING.md) [](./CONTRIBUTING.md)
[](./CONTRIBUTORS.md)
:bulb: Simple buttons you can use easily for your next project.
[](https://www.buymeacoffee.com/shahednasser)
# Contents
- [Get started with sButtons](#get-started-with-sbuttons)
- [Download CSS File](#download-css-file)
- [CDN](#cdn)
- [NPM](#npm)
- [Using in CSS](#using-in-css)
- [Using in LESS](#using-in-less)
- [Modify Colors](#modifying-button-colors)
- [Usage](#usage)
- [Basic Button](#basic-button)
- [Block Buttons](#block-buttons)
- [Disabled Buttons](#disabled-buttons)
- [Only Icon](#only-icon)
- [Icon Positioned to The Left](#icon-positioned-to-the-left)
- [Icon Positioned to The Right](#icon-positioned-to-the-right)
- [Toggle Button](#toggle-button)
- [Toggle Button as Checkboxes](#toggle-button-as-checkboxes)
- [Toggle Button as Radio Button](#toggle-button-as-radio-button)
- [Rounded Buttons](#rounded-buttons)
- [Animated Buttons](#animated-buttons)
- [Dark Mode](#dark-mode)
- [Using dark-mode Class](#using-dark-mode-class)
- [Using data-theme attribute](#using-data-theme-attribute)
- [Contribution](#contribution)
- [Button ideas](#button-ideas)
- [Projects Using sButtons](#projects-using-sbuttons)
- [Contributors](#contributors)
- [LICENSE](#license)
# Get Started with sButtons
## Download CSS File
You can download the (CSS file)(https://raw.githubusercontent.com/sButtons/sbuttons/master/dist/sbuttons.min.css) and then add it to your HTML file in between the tags.
Download the file and link it as a stylesheet in between your `` tags, as shown below.
```html
```
Make sure to replace `"/path/to/sbuttons.min.css"` with the path you stored it in.
## CDN
Or instead of downloading the file, you can use the CDN.
```html
```
In case of using buttons that have icons in them, make sure to include font awesome's CDN in the `` tag.
```html
```
## NPM
You can install sButtons using NPM:
```shell
npm i sbuttons
```
## Using in CSS
You can import the CSS file found in `dist/sbuttons.css` or `dist/sbuttons.min.css`:
```css
@import url("~sbuttons/dist/sbuttons.min.css");
```
## Using in LESS
You can also import the less file found in `src/sbuttons.less`:
```css
@import "~sbuttons/src/sbuttons.less";
```
## Modify Colors
To modify button colors, `import src/_variables.less` in your less file, then make changes to the variables after the import.
For example, to change the blue color to a different shade:
```css
@import "/path/to/_variables.less";
@blue: #54a2bd; /* Make it darker */
```
Check out [_variables.less](https://github.com/sButtons/sbuttons/blob/master/src/_variables.less) for the full list of variables.
# Usage
## Basic Button
To use sButtons in your project, just add the classes of sButton you want to either `` or `` tags.
```html
Button
```
You can find all classes mentioned in our [Examples](https://sbuttons.netlify.app/examples) page.
## Block Buttons
To use sButtons with block display, add the class to either `` or ``.
```html
Button
```
## Disabled Buttons
To make a `` or `` tag disabled, add `disabled-btn` class as shown below.
```html
Button
```
## Icon Buttons
The `base-icon-btn` class enables you to have a normal, customizable icon button. Using it, you decide to add any fontawesome icon in it. You can choose to either place it on the left or right side of the button with the available classes.
## Only Icon
The `icon-btn` class alone gives you a default button with no background color and border.
```html
```
## Icon Positioned to The Left
Adding the icon-left class to a button makes the icon positioned to the left.
```html
Read
```
## Icon Positioned to The Right
Adding the `icon-right` class to a button makes the icon
positioned to the right.
```html
Read
```
## Toggle Button
The `toggle-btn` class, along with the `toggle-off-btn` / `toggle-on-btn` state class enables you to have a toggle button. Apart from the basic use, it can also be used for checkboxes and radio buttons. While not necessary, you can use the available state classes to choose whether your checkboxes and radio buttons are checked or not.
## Toggle Button as Checkboxes
Adding the `toggle-btn` class to your checkbox inputs converts them to toggle buttons.
For example:
```html
```
## Toggle Button as Radio Buttons
Adding the `toggle-btn` class to your radio inputs converts them to toggle buttons.
```html
```
## Rounded buttons
To add the rounded buttons with a particular radius, you can use various classes like `rounded-x-btn` where x is the radius in pixels which you want. Here x ranges from `5`(border-radius = 5px) to `fully rounded`(border-radius = 50%).
```html
Rounded button
```
## Animated Buttons
To use Animated sButtons in your project, add the classes of the animated sButton you want to either `` or `` tags.
```html
Animated Button
```
Note: Depending on your button, the animation should either run infinitely or just once.
## Dark Mode
sButtons is compatible with dark mode. It either works by adding dark-mode class to buttons, or by adding data-theme="dark" to a container element.
## Using dark-mode Class
```html
Dark-Mode
```
## Using data-theme attribute
By adding `data-theme="dark"` to a parent element like the body or a div element, the button will automatically be in dark mode.
```html
Dark-Mode
```
Note: `data-theme="dark"` attribute does not give dark mode styling to the container element, you have to do that yourself. It only toggles sButtons to be in dark mode.
# Contribution
Please see the [contributing guidelines](./CONTRIBUTING.md) for details.
You can also join or start [discussions](https://github.com/sButtons/sbuttons/discussions) with the community members if you have any ideas or questions!
### Button ideas
If you would like to suggest a new button idea, please create a [new discussion](https://github.com/sButtons/sbuttons/discussions/new) with the category "idea".
### Projects Using sButtons
If your project uses sButtons, please submit it [here](https://github.com/sButtons/sbuttons/issues/1255) to be added to the list of the websites using it!
# Contributors
Check out our awesome contributors [here](./CONTRIBUTORS.md)!
# LICENSE
[MIT](./LICENSE)