# group_button 5.3.4

Flutter custom widget to make a group buttons. Included Radio and CheckBox buttons.




## Installing
```
export PUB_HOSTED_URL=https://pub.mirror.p-hatan.com
flutter pub add 'group_button:5.3.4'
```
Published: 2024-01-09T08:58:31.062648Z
Expected archive SHA-256: 0610fcf28ed122bfb4b410fce161a390f7f2531d55d1d65c5375982001415940

Available in cache; verification: upstream_checksum
## Direct dependencies
- flutter: map[sdk:flutter]

## Package README (untrusted upstream documentation)
<div align="center">
  <img src="https://github.com/Frezyx/group_button/blob/master/example/rep_files/new/logo.svg?raw=true" width="400px">
</div>

<h2 align="center"> Flutter widget to create a group of buttons fast 🚀 </h2>

<p align="center">
Included Radio and CheckBox buttons models with custom groping types 🤤
   <br>
   <span style="font-size: 0.9em"> Show some ❤️ and <a href="https://github.com/Frezyx/group_button">star the repo</a> to support the project! </span>
</p>

<p align="center">
  <a href="https://pub.dev/packages/group_button"><img src="https://img.shields.io/pub/v/group_button.svg" alt="Pub"></a>
  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
  <a href="https://github.com/Frezyx/group_button"><img src="https://hits.dwyl.com/Frezyx/group_button.svg?style=flat" alt="Repository views"></a>
  <a href="https://github.com/Frezyx/group_button"><img src="https://img.shields.io/github/stars/Frezyx/group_button?style=social" alt="Pub"></a>
</p>
<p align="center">
  <a href="https://pub.dev/packages/group_button/score"><img src="https://img.shields.io/pub/likes/group_button?logo=flutter" alt="Pub likes"></a>
  <a href="https://pub.dev/packages/group_button/score"><img src="https://img.shields.io/pub/popularity/group_button?logo=flutter" alt="Pub popularity"></a>
  <a href="https://pub.dev/packages/group_button/score"><img src="https://img.shields.io/pub/points/group_button?logo=flutter" alt="Pub points"></a>
</p>

<br>



|    ![](https://github.com/Frezyx/group_button/blob/master/example/rep_files/new/e1.gif?raw=true)     |    ![](https://github.com/Frezyx/group_button/blob/master/example/rep_files/new/e2.gif?raw=true)     | ![](https://github.com/Frezyx/group_button/blob/master/example/rep_files/new/e3.gif?raw=true) |
| :------------------------------: | :------------------------------: | :------------------------------: |

| GroupButtonController | GroupButtonBuilder | GroupButtonOptions |
| :------------------------------: | :------------------------------: | :------------------------------: |


## Getting Started
Follow these steps to use this package

### Add dependency

```yaml
dependencies:
  group_button: ^5.3.4
```

### Add import package

```dart
import 'package:group_button/group_button.dart';
```

### Easy to use
Simple example of use GroupButton<br>
Put this code in your project at an screen and learn how it works 😊

```dart
GroupButton(
    isRadio: false,
    onSelected: (index, isSelected) => print('$index button is selected'),
    buttons: ["12:00", "13:00", "14:30", "18:00", "19:00", "21:40"],
)
```

### Controller
**Starting from version 4.1.0** <br>
You can control your Group Button using the controller

```dart
final controller = GroupButtonController();

Column(
  children: [
    GroupButton.checkbox(
      controller: controller,
      buttons: ['12:00', '13:00', '14:00'],
      onSelected: (i, selected) => debugPrint('Button #$i $selected'),
    ),
    TextButton(
      onPressed: () => controller.selectIndex(1),
      child: const Text('Select 1 button'),
    )
  ],
),
```

### Generic button value
In new 5.0.0 version you can set custom buttons value type <br>
It can be int, DateTime, double or YourCustomClass <br>
Button text will be result of .toString() model method in common button display case <br>
```dart
GroupButton<DateTime>(
  buttons: [DateTime(2022, 4, 9), DateTime(2022, 4, 10)],
)
```

### Button builders

Also you can use generic button values with cutsom buttonBuilder <br>
In order to turn values into any widget
```dart
GroupButton<DateTime>(
  buttons: [DateTime(2022, 4, 9), DateTime(2022, 4, 10)],
  buttonBuilder: (selected, date, context) {
    return Text('${date.year}-${date.month}-${date.day}');
  },
),
```

In this package, there are four different possibilities for customizing your buttons through builders

- 1 **buttonBuilder** It will build a fully custom button based on the value parameter
- 2 **buttonIndexedBuilder** same as buttonBuilder. But based on button index. 
- 3 **buttonTextBuilder** It will replace the text of your button, which is constructed based on the style parameters passed in GroupButtonOptions. The appearance of the button remains the same, but the text is changed. Based on button value. 
- 4 **buttonIndexedTextBuilder** same as buttonTextBuilder. But based on button index. 

### Fully Customize
In order to customize your buttons inside *GroupButton* you can use *GroupButtonOptions*

```dart
GroupButtonOptions(
  selectedShadow: const [],
  selectedTextStyle: TextStyle(
    fontSize: 20,
    color: Colors.pink[900],
  ),
  selectedColor: Colors.pink[100],
  unselectedShadow: const [],
  unselectedColor: Colors.amber[100],
  unselectedTextStyle: TextStyle(
    fontSize: 20,
    color: Colors.amber[900],
  ),
  selectedBorderColor: Colors.pink[900],
  unselectedBorderColor: Colors.amber[900],
  borderRadius: BorderRadius.circular(100),
  spacing: 10,
  runSpacing: 10,
  groupingType: GroupingType.wrap,
  direction: Axis.horizontal,
  buttonHeight: 60,
  buttonWidth: 60,
  mainGroupAlignment: MainGroupAlignment.start,
  crossGroupAlignment: CrossGroupAlignment.start,
  groupRunAlignment: GroupRunAlignment.start,
  textAlign: TextAlign.center,
  textPadding: EdgeInsets.zero,
  alignment: Alignment.center,
  elevation: 0,
),
```

![](https://github.com/Frezyx/group_button/blob/master/example/rep_files/options_example.png?raw=true) 

### Examples
You can check more examples of using this package [here](example/lib)

<br>
<div align="center" >
  <p>Thanks to all contributors of this package</p>
  <a href="https://github.com/Frezyx/group_button/graphs/contributors">
    <img src="https://contrib.rocks/image?repo=Frezyx/group_button" />
  </a>
</div>
<br>

For help getting started with 😍 Flutter, view
[online documentation](https://flutter.dev/docs), which offers tutorials, 
samples, guidance on mobile development, and a full API reference.



## Changelog
# 5.3.4
- Fix deprecated member 'primary'

Thanks to [NeroThroN](https://github.com/NeroThroN)

# 5.3.3
- Remove self linter with **flutter_lints**
- Fix linter issues
- Format files

# 5.3.2
- Update sdk version to **'>=2.15.0 <4.0.0'**

# 5.3.1
- Add topics in pubspec.yaml
- Remove deprecated linter rules

## 5.3.0

- Implement **buttonIndexedTextBuilder** and **buttonTextBuilder** 
for building only text of buttons. See more in [docs](https://github.com/Frezyx/group_button)
- Recreate example host folders

## 5.2.2
- **INFO** Update README badages
## 5.2.1
- **INFO** Compatibility with flutter version under 3.3.0

## 5.2.0
 - **INFO**: Make the package compatible with the 3.3.0 Flutter version 
 - **FIX**: Analyser issues

## 5.1.0 
 - **BREAKING**: idnex -> index change typo fix for onDisablePressed callback Function of GroupButtonController
 - **INFO**: Examples and code base refactoring

 Thanks for [anasfik](https://github.com/anasfik)

## 5.0.1 
 - **FEAT**: Added user friendly example

 Thanks for [vasilich6107](https://github.com/vasilich6107)

## 5.0.0
 - **MAIN FEAT**: GroupButton\<T> now is generic class.<br>
 Now you can create int, DateTime, double or YourCustomClass typed buttons List for default GroupButton constructor.<br> **More** [here](https://github.com/Frezyx/group_button/blob/master/example/lib/examples/generics_example/generics_example.dart)

 - **BREAKING**: All deprecated by *4.3.0* and *4.6.0* fields was removed from package.<br> 
**More** [here](https://github.com/Frezyx/group_button#customize)

 - **BREAKING**: buttonBuilder from *4.6.0* now build buttons by value <br> 
The buttonIndexedBuilder took over the past functionality of the buttonBuilder

- **INFO**: Updated examples & README

## 4.8.0
 - **FEAT**: Added enableIndexes abd disableIndexes methods for controller

 Thanks for [minhdanh](https://github.com/minhdanh)

## 4.7.0
 - **FEAT**: Added maxSelected field for setting max selected 
 buttons in checkbox mode

 Thanks for [gnassro](https://github.com/gnassro)

## 4.6.0
- **FEAT**: Added buttonBuilder field for 
 implementing your own custom buttons 
- **FEAT**: Added ButtonBuilderExample with 
Flutter default radio and chackbox buttons via buttonBuilder
- **INFO**: Updated examples & README


## 4.5.0
 - **FEAT**: [enableDeselect](https://github.com/Frezyx/group_button/blob/master/lib/src/group_button_base.dart#:~:text=final%20bool%3F-,enableDeselect,-%3B) 
 field for enable radio button deselect

## 4.4.0
 - **BREAKING**: remove GroupButton.checkbox() and GroupButton.radio() constructors from 4.0.0 updates

## 4.3.0
 - **FEAT**: Implment **GroupButtonOptions** model to pass all styles of widget via one field
 - **DEPRECATED**: All styles fields in default GroupButton constructor now deprecated. 
<br>In new version of package send it via **GroupButtonOptions**
--------------------
List of fields:
- groupingType
- direction
- spacing
- runSpacing
- selectedTextStyle
- unselectedTextStyle
- selectedColor
- unselectedColor
- selectedBorderColor
- unselectedBorderColor
- borderRadius
- selectedShadow
- unselectedShadow
- buttonHeight
- buttonWidth
- mainGroupAlignment
- crossGroupAlignment
- groupRunAlignment
- textAlign
- textPadding
- alignment
- elevation
## 4.2.1
 - **FIX**: deprecated fields

## 4.2.0
 - **FEAT**: Add disabled buttons to controller
 - **FEAT**: Add controller fields initialization in controller constructor
 - **INFO**: Add deprecatd annotation for selectedButton, selectedButtons and disabledButtons

## 4.1.1
 - **FIX**: GroupbuttonController initialization
## 4.1.0
 - **FEAT**: [onDisablePressed](https://github.com/Frezyx/group_button/blob/master/lib/src/group_button_base.dart#:~:text=Function(int%20index)%3F-,onDisablePressed,-%3B) calback method for handle taps on disabled buttons

## 4.0.0
 - **FEAT**: [GroupButtonController](https://github.com/Frezyx/group_button/blob/master/lib/src/utils/controller.dart) for working with GroupButton from the outside
 - **FEAT**: New GroupButton factory constructors [GroupButton.checkbox](https://github.com/Frezyx/group_button/blob/master/lib/src/group_button_base.dart#:~:text=///%20Build%20group%20button,button%20is%20seletced) and [GroupButton.checkbox](https://github.com/Frezyx/group_button/blob/master/lib/src/group_button_base.dart#:~:text=///%20Build%20group%20button%20for%20choising%20several,or%20unselected%20with%20%5Bbool%20selected%5D%20field) for faster buttons group creation
- **FIX**: Common issues

 Thanks for [bookyo](https://github.com/bookyo) and [mwm0022](https://github.com/mwm0022)

## 3.3.1
 - **FIX**: fix static analysis issues

## 3.3.0
 - **FEAT**: Add [alignment](https://github.com/Frezyx/group_button/blob/master/lib/group_button.dart#:~:text=///%20%5BAlignment%5D%20Text%20position,final%20AlignmentGeometry%3F%20alignment%3B) field
 - **FEAT**: Add [elevation](https://github.com/Frezyx/group_button/blob/master/lib/group_button.dart#:~:text=///%20%5Bdouble%5D%20The%20buttons,final%20double%3F%20elevation%3B) field
 - **FEAT**: Add [disabledButtons](https://github.com/Frezyx/group_button/blob/master/lib/group_button.dart#:~:text=///%20%5Bint%5D%20button%20ids,List%3Cint%3E%3F%20disabledButtons%3B) field

 Thanks for [slavap](https://github.com/slavap)

## 3.2.0
 - **FEAT**: Add [textAlign](https://github.com/Frezyx/group_button/blob/master/lib/group_button.dart#:~:text=///%20%5BTextAlign%5D%20The%20buttons,final%20TextAlign%20textAlign%3B) field
 - **FEAT**: Add [textPadding](https://github.com/Frezyx/group_button/blob/master/lib/group_button.dart#:~:text=///%20%5BEdgeInsets%5D%20The%20inner,final%20EdgeInsets%20textPadding%3B) field

## 3.1.0
 - **FEAT**: Add runSpacing field !
             When [groupingType] is [GroupingType.wrap] this field sets Wrap [runSpacing]
 - **BREAKING**: Now spacing field is not sets GroupButton items vertical spacing

## 3.0.1
 - **FIX**: Remove initial selected button from original widget 
            initialization

## 3.0.0+1
 - **FIX**: fix app logo link
## 3.0.0
 - **BREAKING**: Implement groupingType field to make different 
    grouping types like Wrap, Column, Row
 - **FEAT**: Remove default values of styling fields for delegate this to theme
 - refactoring: Make some internal refactoring

## 2.4.1

 - **FIX**: fix static analysis issues

## 2.4.0

 - **FEAT**: implement `runGroupAlignment` field for placed buttons runs themselves along the cross axis in a layout.

## 2.3.0

 - **FEAT**: implement `mainGroupAlignment` field for placed buttons in the main axis in a layout.
 - **FEAT**: implement `crossGroupAlignment` field for placed buttons along the cross axis in a layout.


## 2.2.2 - 2021-06-05

* Create example with using provider as state-manager 

## 2.2.1 - 2021-06-01

* Update examples in README.md 

## 2.2.0 - 2021-06-01

* Remove provider dependency
* Fix fields passing for widget
* Update selectedButtons field (Now int like index)
* Add selectedButton field for radio type

## 2.1.2 - 2021-05-04

*  Fix selectedBorderColor not working exception

## 2.1.1 - 2021-05-04

*  Fix spacing error issue

## 2.1.0 - 2021-04-06

*  Add ability for using radio mode without an selected buttons

## 2.0.0+1 - 2021-04-06

*  Fix static analysis issues

## 2.0.0 - 2021-04-06

*  Migrate to null-safety [commit](https://github.com/Frezyx/group_button/pull/13/commits/fb7fd02c97bd6e27dc83f125cb6749e3ef467397)

## 1.3.0 - 2021-03-04

*  Migrate from using RaisedButton to ElevatedButton

## 1.2.0 - 2021-03-03

* Add width and height fields for buttons

## 1.1.1 - 2021-02-20

* Refactor code
* Add lint package

## 1.1.0 - 2020-10-19

* Added ability to set initially selected buttons

## 1.0.2 - 2020-08-11

* Create travis & codemagic QA

## 1.0.1 - 2020-08-11

* Fix dart analyzer issues, errors and remarks

## 1.0.0 - 2020-08-11

* Basic functionality for creating a button group
* Two models of the group were created: 
    + Radio (one selected button)
    + CheckBox (several selected buttons)

## 0.1.0 - 2020-08-9

* Initial package skeleton