mirror of
https://github.com/Iconica-Development/flutter_nested_categories.git
synced 2025-05-18 23:33:44 +02:00
8fce7a499e
* feat: add nested category functionality * feat(example): add nested category example app * chore(changelog): add v0.0.1 changelog * chore(readme): add readme * feat(custom-header): add custom category header functionality * feat(header_style): add default header style requirement * feat(capitalization): add header capitalization * fix: feedback * fix: feedback
69 lines
2 KiB
Markdown
69 lines
2 KiB
Markdown
# flutter_nested_categories
|
|
|
|
This Flutter component allows you to easily create nested categories that are very
|
|
customizable.
|
|
|
|
## Features
|
|
|
|
* Nested Categories
|
|
* Collapsible Categories
|
|
|
|
## Usage
|
|
|
|
You can build a nested category using the `CategoryList` class, like this:
|
|
|
|
```dart
|
|
CategoryList(
|
|
content: [
|
|
Category(
|
|
name: "Category 1",
|
|
content: [
|
|
const Text("Content 1"),
|
|
const Text("Content 2"),
|
|
],
|
|
nestedCategories: [
|
|
Category(
|
|
name: "Category 1.1",
|
|
content: [
|
|
const Text("Content 1.1"),
|
|
const Text("Content 1.2"),
|
|
],
|
|
),
|
|
],
|
|
),
|
|
],
|
|
),
|
|
```
|
|
|
|
You have a bunch of customization options available as well, such as:
|
|
|
|
* Setting a (text)title (and title styling/center),
|
|
* Setting a custom title,
|
|
* Collapsible categories,
|
|
* Header styling.
|
|
|
|
For a more detailed example you can see the [example](https://github.com/Iconica-Development/flutter_nested_categories/tree/main/example).
|
|
|
|
Or, you could run the example yourself:
|
|
```
|
|
git clone https://github.com/Iconica-Development/flutter_nested_categories.git
|
|
|
|
cd flutter_nested_categories
|
|
|
|
cd example
|
|
|
|
flutter run
|
|
```
|
|
|
|
## Issues
|
|
|
|
Please file any issues, bugs or feature request as an issue on our [GitHub](https://github.com/Iconica-Development/flutter_nested_categories) page. Commercial support is available if you need help with integration with your app or services. You can contact us at [support@iconica.nl](mailto:support@iconica.nl).
|
|
|
|
## Want to contribute
|
|
|
|
If you would like to contribute to the component (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our [contribution guide](./CONTRIBUTING.md) and send us your [pull request](https://github.com/Iconica-Development/flutter_nested_categories/pulls).
|
|
|
|
## Author
|
|
|
|
This flutter_thermal_printer for Flutter is developed by [Iconica](https://iconica.nl). You can contact us at <support@iconica.nl>
|