From 255db24e4ceeb4767d8407ea46de1481b0c37201 Mon Sep 17 00:00:00 2001 From: Carlos Costa Date: Wed, 10 Apr 2024 17:03:05 -0300 Subject: [PATCH] Update Readme --- README.md | 4 ++-- docs/vw_page.md | 4 ++-- docs/vw_select.md | 4 ++-- docs/vw_timepicker.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 54b3b21..0b0ac66 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ > This project is a collection of custom, reusable widgets designed to provide additional functionality and customization options beyond the standard Flutter widgets. -### Installation +## Installation Add the following to your `pubspec.yaml` file: @@ -17,7 +17,7 @@ dependencies: url: https://github.com/C4co/vw.git ``` -### Widgets +## Widgets - [VWButton](https://github.com/C4co/vw/blob/master/docs/vw_button.md): A customizable button with options for full width, custom colors, gradients, splash color, and icon placements. diff --git a/docs/vw_page.md b/docs/vw_page.md index b186ec7..3a50ba6 100644 --- a/docs/vw_page.md +++ b/docs/vw_page.md @@ -1,4 +1,4 @@ -## VWPage +# VWPage A sealed class that provides a method to open a new page. @@ -8,7 +8,7 @@ VWPage is a floating page, which means that it is not a full-screen page, but a | ------ | ----------------- | | `open` | Opens a new page. | -### open method +## open method | Parameter | Type | Description | | --------- | ------------ | ------------------------------------------------------------------------------------- | diff --git a/docs/vw_select.md b/docs/vw_select.md index b9f0b65..44657f0 100644 --- a/docs/vw_select.md +++ b/docs/vw_select.md @@ -1,4 +1,4 @@ -## VWSelect +# VWSelect A StatelessWidget that provides a customizable select option widget. @@ -12,7 +12,7 @@ A StatelessWidget that provides a customizable select option widget. | `headerBoxDecoration` | BoxDecoration? | The decoration to show around the header of the dropdown menu. | | `validator` | String? Function(String? value)? | Called when the user submits the form. | -### VWSelectOption +## VWSelectOption A class that represents an option in the dropdown menu. diff --git a/docs/vw_timepicker.md b/docs/vw_timepicker.md index d13ff5b..05319c1 100644 --- a/docs/vw_timepicker.md +++ b/docs/vw_timepicker.md @@ -1,4 +1,4 @@ -## VWTimePicker +# VWTimePicker A StatefulWidget that provides a customizable time picker. @@ -15,7 +15,7 @@ A StatefulWidget that provides a customizable time picker. | `errorInvalidText` | `String` | The error invalid text to show in the time picker. | | `style` | `TextStyle` | Style to decorate textfield | -Example usage: +## Example ```dart VWTimePicker(