Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/boringdeveloper/FlutterSwitch

A Custom Switch package created for Flutter.
https://github.com/boringdeveloper/FlutterSwitch

custom-switch dart dart-package flutter flutter-package flutter-widget pub

Last synced: 3 months ago
JSON representation

A Custom Switch package created for Flutter.

Host: GitHub
URL: https://github.com/boringdeveloper/FlutterSwitch
Owner: boringdeveloper
License: bsd-3-clause
Created: 2020-05-09T12:10:18.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-03-16T12:00:22.000Z (8 months ago)
Last Synced: 2024-06-28T01:46:20.278Z (4 months ago)
Topics: custom-switch, dart, dart-package, flutter, flutter-package, flutter-widget, pub
Language: Dart
Homepage: https://pub.dev/packages/flutter_switch
Size: 175 KB
Stars: 76
Watchers: 2
Forks: 63
Open Issues: 22
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # flutter_switch

[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)

[![pub package](https://img.shields.io/pub/v/flutter_switch.svg)](https://pub.dev/packages/flutter_switch) [![pub points](https://badges.bar/flutter_switch/pub%20points)](https://pub.dev/packages/flutter_switch/score) [![popularity](https://badges.bar/flutter_switch/popularity)](https://pub.dev/packages/flutter_switch/score) [![likes](https://badges.bar/flutter_switch/likes)](https://pub.dev/packages/flutter_switch/score) 

An easy to implement custom switch created for Flutter. Give it a custom height and width, border for the switch and toggle, border radius, colors, toggle size, a choice to display an 'On' and 'Off' text and able to add an icon inside the toggle.

 [![GitHub followers](https://img.shields.io/github/followers/boringdeveloper.svg?style=social&label=Follow)](https://github.com/boringdeveloper)   

## Demo

 ![flutter_switch](https://media0.giphy.com/media/zQ7AwA3SiAzqiFCW1o/giphy.gif) 

 

 Video version: https://youtu.be/JqJnxjE6Efc

## Use this package as a library

Add this to your package's `pubspec.yaml` file:

```yaml

dependencies:

  flutter_switch: ^0.3.1

```

You can install packages from the command line with Flutter:

```bash

$ flutter pub get

```

Import in your project:

```dart

import 'package:flutter_switch/flutter_switch.dart';

```

## Sample Usage

```dart

class MyHomePage extends StatefulWidget {

  @override

  _MyHomePageState createState() => _MyHomePageState();

}

class _MyHomePageState extends State {

  bool status = false;

  @override

  Widget build(BuildContext context) {

    return Scaffold(

      appBar: AppBar(

        title: Text("FlutterSwitch Demo"),

      ),

      body: Center(

        child: Container(

          child: FlutterSwitch(

            width: 125.0,

            height: 55.0,

            valueFontSize: 25.0,

            toggleSize: 45.0,

            value: status,

            borderRadius: 30.0,

            padding: 8.0,

            showOnOff: true,

            onToggle: (val) {

              setState(() {

                status = val;

              });

            },

          ),

        ),

      ),

    );

  }

}

```

## Want to Contribute?

Contributions to this project is very much welcome. Let's work together to maintain and improve the project

Simply Fork the repository, Commit and Push your changes and create a new Pull Request.

    

Don't forget to try out the example project under the ./example folder.

    

Also test your changes by running this command.

```bash

$ flutter test

```

If you have some suggestions, you can reach me at [email protected]

# License

    BSD 3-Clause License

    Copyright (c) 2020, Nichole John Romero

    All rights reserved.

    Redistribution and use in source and binary forms, with or without

    modification, are permitted provided that the following conditions are met:

        1. Redistributions of source code must retain the above copyright notice, this

        list of conditions and the following disclaimer.

        2. Redistributions in binary form must reproduce the above copyright notice,

        this list of conditions and the following disclaimer in the documentation

        and/or other materials provided with the distribution.

        3. Neither the name of the copyright holder nor the names of its

        contributors may be used to endorse or promote products derived from

        this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE

    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_Nickr
💻 📖 🚧 ⚠️

    
_{Lucas Eduardo}
💻

    
_{Douglas Ramos}
💻

    
_{Daniyil Yevtyushkin}
💻 ⚠️

    
_{Maksim Nikolaev}
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!