Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davigmacode/flutter_disclosure
Simplify building custom UIs with accessible controls for showing and hiding content, like accordion panels.
https://github.com/davigmacode/flutter_disclosure
Last synced: about 1 month ago
JSON representation
Simplify building custom UIs with accessible controls for showing and hiding content, like accordion panels.
- Host: GitHub
- URL: https://github.com/davigmacode/flutter_disclosure
- Owner: davigmacode
- License: bsd-3-clause
- Created: 2024-03-27T06:47:12.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-06-07T10:41:38.000Z (7 months ago)
- Last Synced: 2024-07-21T13:41:19.087Z (6 months ago)
- Language: Dart
- Homepage: https://pub.dev/packages/disclosure
- Size: 16.6 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://pub.dev/packages/disclosure)  [](https://www.buymeacoffee.com/davigmacode) [](https://ko-fi.com/davigmacode)
Simplify building custom UIs with accessible controls for showing and hiding content, like accordion panels.
[](https://davigmacode.github.io/flutter_disclosure)
[Demo](https://davigmacode.github.io/flutter_disclosure)
## Usage
To read more about classes and other references used by `disclosure`, see the [API Reference](https://pub.dev/documentation/disclosure/latest/).
### Import the package
```dart
import 'package:disclosure/disclosure.dart';
```
### Disclosure panel with scrollable content
```dart
/** spellchecker: disable */
Disclosure(
wrapper: (state, child) {
return Card.outlined(
color: state.closed ? null : Colors.yellow.shade100,
clipBehavior: Clip.antiAlias,
shape: RoundedRectangleBorder(
side: BorderSide(
color: state.closed ? Colors.black26 : Colors.amber,
width: state.closed ? 1 : 2,
),
),
borderRadius: BorderRadius.circular(10),
child: child,
);
},
header: const DisclosureButton(
child: ListTile(
title: Text('Disclosure Panel'),
trailing: DisclosureIcon(),
),
),
divider: const Divider(height: 1),
child: const DisclosureView(
maxHeight: 200,
padding: EdgeInsets.all(15.0),
child: Text(
"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
),
),
)
```
### Grouped multiple disclosure
```dart
DisclosureGroup(
multiple: false,
clearable: true,
insets: const EdgeInsets.all(15),
children: List.generate(5, (i) {
return Disclosure(
key: ValueKey('disclosure-$i'),
wrapper: (state, child) {
return Card.outlined(
color: state.closed ? null : Colors.yellow.shade100,
clipBehavior: Clip.antiAlias,
shape: RoundedRectangleBorder(
side: BorderSide(
color: state.closed ? Colors.black26 : Colors.amber,
width: state.closed ? 1 : 2,
),
),
child: child,
);
},
header: DisclosureButton(
child: ListTile(
title: Text('Disclosure Panel ${i + 1}'),
trailing: const DisclosureIcon(),
),
),
divider: const Divider(height: 1),
child: const Padding(
padding: EdgeInsets.all(15),
child: Text(
"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen.",
),
),
);
}),
)
```
### Disclosure tile for menus and lists
```dart
DisclosureTile(
title: const Text('Nested Menu'),
children: [
DisclosureTile(
title: const Text('Menu Item'),
onTap: () {},
),
DisclosureTile(
title: const Text('Nested Menu'),
children: [
DisclosureTile(
title: const Text('Menu Item'),
onTap: () {},
),
],
),
],
),
```
### Complex implementation with secondary actions and grid layout
```dart
Disclosure(
secondary: DisclosureButton.basic(
child: Image.network(
'https://picsum.photos/500?image=1',
fit: BoxFit.cover,
),
),
child: Column(
mainAxisSize: MainAxisSize.min,
children: [
GridView(
shrinkWrap: true,
gridDelegate: const SliverGridDelegateWithFixedCrossAxisCount(
crossAxisCount: 3,
),
children: [
Image.network('https://picsum.photos/150?image=1'),
Image.network('https://picsum.photos/150?image=2'),
Image.network('https://picsum.photos/150?image=3'),
Image.network('https://picsum.photos/150?image=4'),
Image.network('https://picsum.photos/150?image=5'),
Image.network('https://picsum.photos/150?image=6'),
Image.network('https://picsum.photos/150?image=7'),
Image.network('https://picsum.photos/150?image=8'),
Image.network('https://picsum.photos/150?image=9'),
],
),
const Padding(
padding: EdgeInsets.all(15.0),
child: Text(
"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
),
),
DisclosureButton(
wrapper: DisclosureButtonWrapper.outlined,
child: Text('Close'),
),
const SizedBox(height: 20),
],
),
)
```
### Spoiler text with limited visibility
```dart
Disclosure(
closed: true,
secondary: DisclosureButton(
child: Padding(
padding: EdgeInsets.all(20.0),
child: Text(
"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
maxLines: 2,
overflow: TextOverflow.ellipsis,
),
),
),
child: Padding(
padding: EdgeInsets.all(20.0),
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Text(
"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
),
SizedBox(height: 20),
DisclosureButton.tonal(
child: Text(
'Show less',
style: TextStyle(fontWeight: FontWeight.bold),
),
),
],
),
),
)
```
## Sponsoring
If this package or any other package I created is helping you, please consider to sponsor me so that I can take time to read the issues, fix bugs, merge pull requests and add features to these packages.