flutter_nested_categories/README.md

69 lines
2 KiB
Markdown
Raw Normal View History

2024-04-03 16:50:57 +02:00
# flutter_nested_categories
2024-04-03 16:50:57 +02:00
This Flutter component allows you to easily create nested categories that are very
customizable.
2024-04-03 16:50:57 +02:00
## Features
2024-04-03 16:50:57 +02:00
* Nested Categories
* Collapsible Categories
2024-04-03 16:50:57 +02:00
## Usage
2024-04-03 16:50:57 +02:00
You can build a nested category using the `CategoryList` class, like this:
2024-04-03 16:50:57 +02:00
```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"),
],
),
],
),
],
),
```
2024-04-03 16:50:57 +02:00
You have a bunch of customization options available as well, such as:
2024-04-03 16:50:57 +02:00
* Setting a (text)title (and title styling/center),
* Setting a custom title,
* Collapsible categories,
* Header styling.
2024-04-03 16:50:57 +02:00
For a more detailed example you can see the [example](https://github.com/Iconica-Development/flutter_nested_categories/tree/main/example).
2024-04-03 16:50:57 +02:00
Or, you could run the example yourself:
```
2024-04-03 16:50:57 +02:00
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).
2024-04-03 16:50:57 +02:00
## Author
2024-04-03 16:50:57 +02:00
This flutter_thermal_printer for Flutter is developed by [Iconica](https://iconica.nl). You can contact us at <support@iconica.nl>