Skip to content

Commit

Permalink
docs - minot fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Inbal-Tish committed Mar 21, 2023
1 parent 1f9823f commit 00c2877
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
12 changes: 6 additions & 6 deletions docsRNC/docs/Components/Calendar.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ Whether to disable all touch events for inactive days (can be override with 'dis

**Disclaimer**: Make sure that `markedDates` param is immutable. If you change `markedDates` object content but the reference to it does not change calendar update will not be triggered.

Dot marking
- Dot marking

<img height={50} src="https://github.com/wix-private/wix-react-native-calendar/blob/master/demo/assets/marking1.png?raw=true"/>

Expand All @@ -276,7 +276,7 @@ Dot marking

You can customize a dot color for each day independently.

Multi-Dot marking
- Multi-Dot marking

<img height={50} src="https://github.com/wix-private/wix-react-native-calendar/blob/master/demo/assets/marking4.png?raw=true"/>

Expand All @@ -297,7 +297,7 @@ const workout = {key: 'workout', color: 'green'};
/>;
```

Period marking
- Period marking

<img height={50} src="https://github.com/wix-private/wix-react-native-calendar/blob/master/demo/assets/marking2.png?raw=true"/>

Expand All @@ -315,7 +315,7 @@ Period marking
/>
```

Multi-period marking
- Multi-period marking

<img height={50} src="https://github.com/wix-private/wix-react-native-calendar/blob/master/demo/assets/marking6.png?raw=true"/>

Expand Down Expand Up @@ -343,7 +343,7 @@ Multi-period marking
/>
```

Custom marking allows you to customize each marker with custom styles.
- Custom marking (allows you to customize each marker with custom styles)

<img height={50} src="https://github.com/wix-private/wix-react-native-calendar/blob/master/demo/assets/marking5.png?raw=true"/>

Expand Down Expand Up @@ -377,7 +377,7 @@ Custom marking allows you to customize each marker with custom styles.
/>
```

**NEW!** While we still don't support multi marking type, we add the possibility to combine between `period` and `simple`.
**NEW!** While we still don't support multi marking type, we add the possibility to combine between `period` and `dot`.

```javascript
<Calendar
Expand Down
4 changes: 3 additions & 1 deletion docsRNC/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ $ yarn add react-native-calendars

<br/>

`import {`[Calendar](#calendar), [CalendarList](#calendarlist), [Agenda](#agenda)`} from 'react-native-calendars';`
`import {[Calendar](#calendar), [CalendarList](#calendarlist), [Agenda](#agenda)} from 'react-native-calendars';`

All parameters for components are optional. By default the month of current local date will be displayed.

Expand Down Expand Up @@ -128,6 +128,8 @@ LocaleConfig.defaultLocale = 'fr';
- [Tautvilas Mecinskas](https://github.com/tautvilas/) - Initial code - [@tautvilas](https://twitter.com/Tautvilas)
- Katrin Zotchev - Initial design - [@katrin_zot](https://twitter.com/katrin_zot)

- [Inbal Tish](https://github.com/Inbal-Tish) - Main maintainer

See also the list of [contributors](https://github.com/wix/react-native-calendar-components/contributors) who participated in this project.

## Contributing
Expand Down
2 changes: 1 addition & 1 deletion src/calendar/day/basic/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export interface BasicDayProps extends ViewProps {
state?: DayState;
/** The marking object */
marking?: MarkingProps;
/** Date marking style [simple/period/multi-dot/multi-period]. Default = 'simple' */
/** Date marking style [dot/multi-dot/period/multi-period]. Default = 'dot' */
markingType?: MarkingTypes;
/** Theme object */
theme?: Theme;
Expand Down

0 comments on commit 00c2877

Please sign in to comment.