A user story in which users can view and define their own availability. Often used in combination with HRM planning modules
Find a file
2025-05-08 14:27:46 +02:00
.github feat: add component release workflow 2025-02-03 08:10:11 +01:00
apps/example feat: add example templates to the local service and update stream after initialization 2024-07-10 11:12:05 +02:00
packages fix: Add the use of onExit to show BackButton on OverviewScreen 2025-05-08 14:27:46 +02:00
.fvmrc chore: update package configuration to flutter 3.24.3 2025-02-03 08:10:11 +01:00
.gitignore chore: setup monorepo package structure 2024-07-01 16:41:21 +02:00
.pre-commit-config.yaml chore: add pre-commit configuration 2024-07-25 09:44:30 +02:00
availability.gif chore: update readme and add a gif showcasing the userstory 2024-07-29 11:56:32 +02:00
CHANGELOG.md fix: Add the use of onExit to show BackButton on OverviewScreen 2025-05-08 14:27:46 +02:00
CONTRIBUTING.md chore: setup monorepo package structure 2024-07-01 16:41:21 +02:00
LICENSE chore: setup monorepo package structure 2024-07-01 16:41:21 +02:00
melos.yaml refactor: move service from user story to data layer 2024-07-29 10:38:41 +02:00
pubspec.yaml chore: setup monorepo package structure 2024-07-01 16:41:21 +02:00
README.md chore: update readme and add a gif showcasing the userstory 2024-07-29 11:56:32 +02:00

flutter_availability

This package creates an all encompassing implementation for handling time availability use cases. By Default this package runs with a local data implementation that does not persist data. You can add your own implementation by implementing the AvailabilityDataInterface.

All configuration of the userstory is done through the AvailabilityOptions class.

Flutter Availability GIF

Figma Design that defines this component (only accessible for Iconica developers): TO BE CREATED Figma clickable prototype that demonstrates this component (only accessible for Iconica developers): TO BE CREATED

Setup

To use this package, add flutter_availability as a dependency in your pubspec.yaml file:

  flutter_availability:
    git:
      url: https://github.com/Iconica-Development/flutter_availability
      path: packages/flutter_availability
      ref: 1.0.0

You can start the userstory by adding the availability widget like this to your widget tree:

AvailabilityUserStory(
    userId: "userIdOfTheUser",
    options: AvailabilityOptions(),
),

There is also a function for pushing the availability screen to the navigation stack:

openAvailabilitiesForUser(context, "userIdOfTheUser", AvailabilityOptions());

Issues

Please file any issues, bugs or feature request as an issue on our GitHub page. Commercial support is available if you need help with integration with your app or services. You can contact us at support@iconica.nl.

Want to contribute

text 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 and send us your pull request.

Author

This flutter_availability for Flutter is developed by Iconica. You can contact us at support@iconica.nl