https://github.com/yifaneye/checkboxes

Checkboxes ✅ with customisable color, size, border radius and animation time
https://github.com/yifaneye/checkboxes

browser-compatibility checkbox checkboxes css customizable customization gulpjs npm sass scss

Last synced: 4 months ago
JSON representation

Checkboxes ✅ with customisable color, size, border radius and animation time

• Host: GitHub
• URL: https://github.com/yifaneye/checkboxes
• Owner: yifaneye
• License: mit
• Created: 2020-06-19T17:42:21.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T22:03:29.000Z (about 2 years ago)
• Last Synced: 2024-09-28T06:42:01.210Z (4 months ago)
• Topics: browser-compatibility, checkbox, checkboxes, css, customizable, customization, gulpjs, npm, sass, scss
• Language: HTML
• Homepage: http://yifanai.com/cbs
• Size: 1.63 MB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Checkboxes

A library for customizable checkboxes ✅

👉 [Website Demo](https://unpkg.com/[email protected]/dist/checkboxes.html)

## Background

Different browsers have different implementations for checkboxes:

See [this post](https://stackoverflow.com/questions/24322599/why-cannot-change-checkbox-color-whatever-i-do) about not able to style checkboxes. 😭

![checkbox on Safari](https://yifanai.s3-ap-southeast-2.amazonaws.com/checkboxes/safari.jpg)

![checkbox on Chrome](https://yifanai.s3-ap-southeast-2.amazonaws.com/checkboxes/chrome.jpg)

![checkbox on Firefox](https://yifanai.s3-ap-southeast-2.amazonaws.com/checkboxes/firefox.jpg)

![checkbox on Opera](https://yifanai.s3-ap-southeast-2.amazonaws.com/checkboxes/opera.jpg)

![checkbox on Edge](https://yifanai.s3-ap-southeast-2.amazonaws.com/checkboxes/edge.jpg)

Chrome uses the thick white tick, while Safari, Opera, Edge and Firefox all use the thin white tick. 😢

In addition, Safari, Opera and Edge use user's preferred Accent colour (from System Preferences on a Mac) as background for the checkboxes, whereas Chrome and Firefox stick with blue background. 🤯

![macOS System Preferences](https://yifanai.s3-ap-southeast-2.amazonaws.com/checkboxes/preferences.jpg)

These checkboxes by browsers are styled by User Agent style sheets and they can not be overridden easily. 😕 \

Thus, these checkboxes can hardly match the logo and theme colour of a website or a system! 😩

After some work, I successfully styled the checkboxes for our company's website. 😀 \

See [my reflection tweet](https://twitter.com/yifaneye/status/1273599758129483776).

I would like to style them with ease in the future and for everyone, hence the creation of this small side project. 🙌

![checkboxes demo](https://yifanai.s3-ap-southeast-2.amazonaws.com/checkboxes/checkboxes.gif)

There are now a couple of customizable options for the checkboxes. And many more to come!

## Getting Started

### Using CDN

Add this line to HTML file

```

```

✅

### Using NPM

Install checkboxes package using npm

```

npm i checkboxes

```

then \

add this line to index.js

```

require('checkboxes');

```

OR \

add this line to HTML file

```

```

✅

## Usage

Add "checkbox" class to the checkbox input. \

(Optionally, add custom styles to the element to change it from the default styles.)

i.e. \

from

```

```

to

```

```

e.g.

```

```

where the default style is

```

input[type='checkbox'].checkbox {

    --size: 12px;

    --radius: calc(var(--size) / 10);

    --bg: red;

    --color: white;

    --time: 0.5s;

}

```

which can be easily overridden.

## Package Structure

```

.

|-- LICENSE

|-- README.md

|-- dist

|   `-- css

|       `-- checkboxes.min.css

|-- gulpfile.js

|-- package-lock.json

|-- package.json

`-- src

    |-- checkboxes.html

    `-- scss

        `-- checkboxes.scss

```

## Authors

* **Yifan Ai** - *Initial work*

See also the list of [contributors](https://github.com/yifaneye/checkboxes/graphs/contributors) who participated in this project.

## License

This project is licensed under the MIT License