Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ThasianX authored Jul 17, 2020
1 parent fe26eac commit a14d1f2
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,7 @@ public protocol YearlyCalendarDelegate {

This is just a convenience to handle the shortcomings of the `@Published` wrapper which doesn't support `didSet`. Conform to this if you need to do things when a month is displayed or date changes.


### `ElegantCalendarView` & `YearlyCalendarView` & `MonthlyCalendarView`

#### `theme`: The theme of various components of the calendar. Default is royal blue.
#### `theme`: The theme of various components of the calendar. Default is royal blue. Available for `ElegantCalendarView` & `YearlyCalendarView` & `MonthlyCalendarView`

```swift

Expand Down Expand Up @@ -217,9 +214,7 @@ ElegantCalendarView(...)

To configure your own theme, just pass in your color into the `CalendarTheme` initializer. To have dynamic appearance, make sure your `Color` has both a light and dark appearance.

### `ElegantCalendarView` & `MonthlyCalendarView`

#### `allowsHaptics`: Whether haptics is enabled or not. Default is enabled.
#### `allowsHaptics`: Whether haptics is enabled or not. Default is enabled. Available for `ElegantCalendarView` & `MonthlyCalendarView`

```swift

Expand All @@ -230,6 +225,15 @@ ElegantCalendarView(...)

Users get haptics whenever they tap a day, scroll to a new month, or press the scroll back to today button.

#### `frame`: Custom width for the monthly calendar view. Available for `MonthlyCalendarView`

```swift

MonthlyCalendarView(...)
.frame(width: ...)

```

## Use Cases

The following aspects of `ElegantCalendarManager` can be used:
Expand Down Expand Up @@ -263,7 +267,7 @@ If you are using `Package.swift`, you can also add `ElegantCalendar` as a depend
let package = Package(
name: "TestProject",
dependencies: [
.package(url: "https://github.com/ThasianX/ElegantCalendar", from: "4.0.0")
.package(url: "https://github.com/ThasianX/ElegantCalendar", from: "4.1.0")
],
targets: [
.target(name: "TestProject", dependencies: ["ElegantCalendar"])
Expand Down

0 comments on commit a14d1f2

Please sign in to comment.