Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dev-hann committed May 20, 2021
1 parent 4a2965b commit ecfaf3a
Showing 1 changed file with 27 additions and 26 deletions.
53 changes: 27 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Projects using this library should use the stable channel of Flutter
### Content

- [Motivation](#motivation)
- [Roadmap](#roadmap)
- [Installation](#installation)
- [Style](#style)
- [Icons](#icons)
- [Colors](#colors)
Expand Down Expand Up @@ -91,6 +91,31 @@ See also:
- [Cupertino UI for Flutter](https://flutter.dev/docs/development/ui/widgets/cupertino)
- [MacOS UI for Flutter](https://github.com/GroovinChip/macos_ui)

## Installation

You can use two versions of this package:

1. You can use the [github version](https://github.com/bdlukaa/fluent_ui):

```yaml
dependencies:
fluent_ui:
git: https://github.com/bdlukaa/fluent_ui.git
```

Note that this version is not stable. You can see the example app deplyed using the github version [here](https://bdlukaa.github.io/fluent_ui/#/)

2. You can use the [pub version](https://pub.dev/packages/fluent_ui/install):

```yaml
dependencies:
fluent_ui: ^2.0.0
```

Versions published to pub are stable and fully tested.

Finally, run `dart pub get` to downlaod the package

---

# Style
Expand Down Expand Up @@ -1044,11 +1069,9 @@ NoAcrylicBlurEffect(
Currently, the following widgets use acrylic in its implementation:

- [InfoBar](#infobar)
- [Navigation Panel](#navigation-panel)
- [Navigation View](#navigation-view)
- [TabView](#tab-view)

> This widget MAY BE unperformatic on VERY OLD devices because it uses expensive widgets in its composition: `ClipRect` and `BackdropFilter`. It should not affect the most part of the devices
### Screenshots

![Acrylic preview](https://docs.microsoft.com/en-us/windows/uwp/design/style/images/luminosityversustint.png)
Expand Down Expand Up @@ -1078,28 +1101,6 @@ InfoBar(
![Error InfoBar Preview](https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/images/infobar-error-action-button.png)\
![Custom InfoBar Preview](https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/images/infobar-custom-icon-color.png)

## Calendar View

A calendar view lets a user view and interact with a calendar that they can navigate by month, year, or decade. A user can select a single date or a range of dates. It doesn't have a picker surface and the calendar is always visible. [Learn more](https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/calendar-view)

Use a calendar view to let a user pick a single date or a range of dates from an always visible calendar. If you need to let a user select multiple dates at one time, you must use a calendar view. If you need to let a user pick only a single date and don't need a calendar to be always visible, consider using [date picker](#date-picker) control.

The calendar view is made up of 3 separate views: the month view, year view, and decade view. By default, it starts with the month view open. You can specify a startup view by setting the `displayMode` property.

![Calendar View Showcase](https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/images/calendar-view-3-views.png)

Users click the header in the month view to open the year view, and click the header in the year view to open the decade view. Users pick a year in the decade view to return to the year view, and pick a month in the year view to return to the month view. The two arrows to the side of the header navigate forward or backward by month, by year, or by decade.

### Example

```dart
CalendarView()
```

The code above produces the following:

![Calendar Month View Example](https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/images/controls_calendar_monthview.png)

## Date Picker

The date picker gives you a standardized way to let users pick a localized date value using touch, mouse, or keyboard input. [Learn more](https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/date-picker)
Expand Down

0 comments on commit ecfaf3a

Please sign in to comment.