flutter_agenda/README.md

32 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

[![pub package](https://img.shields.io/pub/v/agenda.svg)](https://github.com/Iconica-Development) [![Build status](https://img.shields.io/github/workflow/status/Iconica-Development/agenda/CI)](https://github.com/Iconica-Development/agenda/actions/new) [![style: effective dart](https://img.shields.io/badge/style-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart)
2022-09-01 08:08:44 +02:00
2022-09-02 16:21:52 +02:00
# Agenda
A Flutter package for creating an agenda that displays events per day with an included calendar for picking the date. Multiple events at the same time are alongside each other. There is also the option to stack multiple items at the same time.
The underlying datepicker widget supports marking dates and disabling dates.
2022-09-01 08:08:44 +02:00
![Agenda GIF](agenda.gif)
2022-09-01 08:08:44 +02:00
2023-12-17 11:39:49 +01:00
Figma Design that defines this component (only accessible for Iconica developers): https://www.figma.com/file/4WkjwynOz5wFeFBRqTHPeP/Iconica-Design-System?type=design&node-id=340%3A612&mode=design&t=XulkAJNPQ32ARxWh-1
Figma clickable prototype that demonstrates this component (only accessible for Iconica developers): https://www.figma.com/proto/4WkjwynOz5wFeFBRqTHPeP/Iconica-Design-System?page-id=340%3A611&type=design&node-id=433-15620&viewport=-160%2C212%2C0.17&t=5fagYht1Mhp7ZCIJ-1&scaling=scale-down&starting-point-node-id=433%3A15620&show-proto-sidebar=1&mode=design
2022-09-02 16:21:52 +02:00
Supports all Flutter platforms.
2022-09-01 08:08:44 +02:00
2022-09-02 16:21:52 +02:00
## Usage
2022-09-01 08:08:44 +02:00
To use this package, add `agenda` as a dependency in your pubspec.yaml file.
2022-09-01 08:08:44 +02:00
## How to Use
2022-09-02 16:21:52 +02:00
See the [Example Code](example/lib/main.dart) for an example on how to use this package.
2022-09-01 08:08:44 +02:00
## Issues
Please file any issues, bugs or feature request as an issue on our [GitHub](https://github.com/Iconica-Development/agenda) 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 plugin (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/agenda/pulls).
## Author
This `agenda` for Flutter is developed by [Iconica](https://iconica.nl). You can contact us at <support@iconica.nl>