Giter Club home page Giter Club logo

arkatsy / theme-toggles Goto Github PK

View Code? Open in Web Editor NEW

This project forked from alfiejones/theme-toggles

0.0 0.0 0.0 9.24 MB

Theme toggles is a collection of awesome, easy to use, animated toggles; designed for switching between light and dark modes. It's a modular library which aims to provide an ample customization where needed. Works great utility CSS frameworks such as Tailwindcss.

Home Page: https://toggles.dev

License: MIT License

JavaScript 33.23% TypeScript 56.44% CSS 2.01% HTML 0.02% Handlebars 1.46% SCSS 5.00% MDX 1.84%

theme-toggles's Introduction


NPM version

Theme Toggles

Theme toggles is a collection of awesome, easy to use, animated toggles; designed for switching between light and dark modes. It's a modular library which aims to provide an ample customization where needed. Works great utility CSS frameworks such as Tailwindcss.

This is the v5 branch. The current release version can be found here. Version 5 is a complete refactor of the library

Installing the latest version

You can install the latest version by using:

  • npm install theme-toggles@latest or yarn add theme-toggles@latest.
  • npm install @theme-toggles/react@latest or yarn add @theme-toggles/react@latest.

Packages

Name Version
theme-toggles npm version
@theme-toggles/react npm version

About

Our project provides you with a quick and effortless way to implement well designed toggles. With more websites supporting both light and dark themes, it's important to ensure sites also have a clean and accessible toggle.

We use SVG’s for each of our toggles, animating them with CSS. Using SVG’s instead of html elements like div’s enables us to have minimal markup whilst maintaining a high quality and scalable icon.

Features

  • Tiny ~1.5kb (min and gzip)
  • Accessible
  • Customizable

Roadmap

New development is currently happening on the v5 branch

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.