https://github.com/outdatedguy/list_picker
Flutter package to select item from a given list using a dialog
https://github.com/outdatedguy/list_picker
dart flutter flutter-package package
Last synced: about 1 month ago
JSON representation
Flutter package to select item from a given list using a dialog
- Host: GitHub
- URL: https://github.com/outdatedguy/list_picker
- Owner: OutdatedGuy
- License: bsd-3-clause
- Created: 2022-02-28T21:35:18.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T17:37:18.000Z (over 1 year ago)
- Last Synced: 2025-01-31T02:22:52.859Z (about 1 year ago)
- Topics: dart, flutter, flutter-package, package
- Language: C++
- Homepage: https://pub.dev/packages/list_picker
- Size: 1.41 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# List Picker
list_picker helps you to select an item from a list of items using dialog box without having to write a lot of code.
[![pub package][package_svg]][package]
[![GitHub][license_svg]](LICENSE)
[![GitHub issues][issues_svg]][issues]
[![GitHub issues closed][issues_closed_svg]][issues_closed]
## Features
- `ListPickerField` provides a text field which when tapped opens the dialog box to select item from the given list.
- You can also customize `showDialog` and its `builder` method with `ListPickerDialog` widget.
- Or you can call the `showPickerDialog` function on your custom widget.
## Getting started
#### Add to Dependencies
```yaml
list_picker: ^1.2.0
```
#### Import the package
```dart
import 'package:list_picker/list_picker.dart';
```
## Usage
#### Using variable for the Widget to get values
```dart
class VariableDemo extends StatelessWidget {
VariableDemo({Key? key}) : super(key: key);
final listPickerField = ListPickerField(
label: "Fruit",
items: const ["Apple", "Banana", "Orange", "Pineapple"],
);
@override
Widget build(BuildContext context) {
return Scaffold(
body: Center(
child: listPickerField,
),
);
}
}
```
#### Using controller to get values
```dart
class ControllerDemo extends StatelessWidget {
ControllerDemo({Key? key}) : super(key: key);
final controller = TextEditingController();
@override
Widget build(BuildContext context) {
return Scaffold(
body: Center(
child: ListPickerField(
label: "Fruit",
items: const ["Apple", "Banana", "Orange", "Pineapple"],
controller: controller,
),
),
);
}
}
```
#### Using showPickerDialog function on custom widget
```dart
class DialogFunctionDemo extends StatelessWidget {
const DialogFunctionDemo({Key? key}) : super(key: key);
@override
Widget build(BuildContext context) {
return Scaffold(
body: Center(
child: ElevatedButton(
onPressed: () async {
String? fruit = await showPickerDialog(
context: context,
label: "Fruit",
items: const ["Apple", "Banana", "Orange", "Pineapple"],
);
ScaffoldMessenger.of(context).showSnackBar(
SnackBar(
content: Text(fruit ?? "No fruit selected"),
),
);
},
child: const Text("Select Your Favourite fruit"),
),
),
);
}
}
```
#### Using ListPickerDialog Widget for custom use
```dart
class ListPickerDialogDemo extends StatelessWidget {
const ListPickerDialogDemo({Key? key}) : super(key: key);
@override
Widget build(BuildContext context) {
return Scaffold(
body: Center(
child: ElevatedButton(
onPressed: () async {
String? fruit = await showDialog(
context: context,
builder: (context) => Scaffold(
appBar: AppBar(
title: const Text('List Picker Dialog'),
),
body: const ListPickerDialog(
label: "Fruit",
items: ["Apple", "Banana", "Orange", "Pineapple"],
),
),
);
ScaffoldMessenger.of(context).showSnackBar(
SnackBar(
content: Text(fruit ?? "No fruit selected"),
),
);
},
child: const Text("Select Your Favourite fruit"),
),
),
);
}
}
```
## ListPickerField Getter Methods
- value: returns the selected value
- empty: returns true if no value is selected
### If you liked the package, then please give it a [Like 👍🏼][package] and [Star ⭐][repository]
[package_svg]: https://img.shields.io/pub/v/list_picker.svg?color=blueviolet
[license_svg]: https://img.shields.io/github/license/OutdatedGuy/list_picker.svg?color=purple
[issues_svg]: https://img.shields.io/github/issues/OutdatedGuy/list_picker.svg
[issues_closed_svg]: https://img.shields.io/github/issues-closed/OutdatedGuy/list_picker.svg?color=green
[package]: https://pub.dev/packages/list_picker
[repository]: https://github.com/OutdatedGuy/list_picker
[issues]: https://github.com/OutdatedGuy/list_picker/issues
[issues_closed]: https://github.com/OutdatedGuy/list_picker/issues?q=is%3Aissue+is%3Aclosed