Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
carllosnc committed Apr 10, 2024
1 parent 9bca5fb commit 255db24
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/vw_page.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## VWPage
# VWPage

A sealed class that provides a method to open a new page.

Expand All @@ -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 |
| --------- | ------------ | ------------------------------------------------------------------------------------- |
Expand Down
4 changes: 2 additions & 2 deletions docs/vw_select.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## VWSelect
# VWSelect

A StatelessWidget that provides a customizable select option widget.

Expand All @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/vw_timepicker.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## VWTimePicker
# VWTimePicker

A StatefulWidget that provides a customizable time picker.

Expand All @@ -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(
Expand Down

0 comments on commit 255db24

Please sign in to comment.