diff --git a/README.md b/README.md index 69c9946dad..0a0893bef1 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,6 @@ The package is both **Android** and **iOS** compatible. See our new [Docs site](https://wix.github.io/react-native-calendars/) - ## Try it out You can run example module by performing these steps: diff --git a/demo/assets/RNC.png b/demo/assets/RNC.png deleted file mode 100644 index 748d9caf45..0000000000 Binary files a/demo/assets/RNC.png and /dev/null differ diff --git a/demo/assets/expandable-calendar.gif b/demo/assets/expandable-calendar.gif new file mode 100644 index 0000000000..544e82b5c0 Binary files /dev/null and b/demo/assets/expandable-calendar.gif differ diff --git a/demo/assets/timeline-calendar.gif b/demo/assets/timeline-calendar.gif new file mode 100644 index 0000000000..4a6d93c16f Binary files /dev/null and b/demo/assets/timeline-calendar.gif differ diff --git a/demo/assets/week-calendar.gif b/demo/assets/week-calendar.gif new file mode 100644 index 0000000000..a5e1df1d19 Binary files /dev/null and b/demo/assets/week-calendar.gif differ diff --git a/docsRNC/docs/AgendaList.md b/docsRNC/docs/AgendaList.md index f92b3b61b4..ffc44f1c9b 100644 --- a/docsRNC/docs/AgendaList.md +++ b/docsRNC/docs/AgendaList.md @@ -1,10 +1,13 @@ -Agenda list component +Agenda list component for the `ExpandableCalendar` component. [(code example)](https://github.com/wix/react-native-calendars/blob/master/example/src/screens/expandableCalendar.tsx) :::info This component extends **[FlatList](https://reactnative.dev/docs/flatlist)** props. ::: +**NOTE: This component should be wrapped with `CalendarProvider` component.** -
+
+ +
## API diff --git a/docsRNC/docs/ExpandableCalendar.md b/docsRNC/docs/ExpandableCalendar.md index b2a0e9b9e6..a326f8dcf2 100644 --- a/docsRNC/docs/ExpandableCalendar.md +++ b/docsRNC/docs/ExpandableCalendar.md @@ -3,8 +3,11 @@ Expandable calendar component :::info This component extends **[CalendarList](https://github.com/wix/react-native-calendars/blob/master/src/calendar-list/index.tsx)** props. ::: +**NOTE: This component should be wrapped with `CalendarProvider` component.** -
+
+ +
## API diff --git a/docsRNC/docs/Timeline.md b/docsRNC/docs/Timeline.md index 457c7648b1..d99737f3f5 100644 --- a/docsRNC/docs/Timeline.md +++ b/docsRNC/docs/Timeline.md @@ -4,7 +4,9 @@ Timeline component This component extends **[ScrollView](https://reactnative.dev/docs/scrollview)** props. ::: -
+
+ +
## API diff --git a/docsRNC/docs/WeekCalendar.md b/docsRNC/docs/WeekCalendar.md index 47d7f2dec5..67a53b8014 100644 --- a/docsRNC/docs/WeekCalendar.md +++ b/docsRNC/docs/WeekCalendar.md @@ -4,7 +4,9 @@ Week calendar component This component extends **[CalendarList](https://github.com/wix/react-native-calendars/blob/master/src/calendar-list/index.tsx)** props. ::: -
+
+ +
## API diff --git a/docsRNC/docusaurus.config.js b/docsRNC/docusaurus.config.js index 1a06d58070..7915eb1ea3 100644 --- a/docsRNC/docusaurus.config.js +++ b/docsRNC/docusaurus.config.js @@ -12,7 +12,7 @@ const config = { baseUrl: '/react-native-calendars/', onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', - favicon: 'img/fav-icon.png', + favicon: 'img/logo.png', organizationName: 'wix', // Usually your GitHub org/user name. projectName: 'react-native-calendars', // Usually your repo name. trailingSlash: false, @@ -46,7 +46,7 @@ const config = { title: 'RNC', logo: { alt: 'RNC Logo', - src: 'img/RNC.png' + src: 'img/logo.png' }, items: [ { diff --git a/docsRNC/src/components/HomepageFeatures.js b/docsRNC/src/components/HomepageFeatures.js index d001d8e707..397af4f4b9 100644 --- a/docsRNC/src/components/HomepageFeatures.js +++ b/docsRNC/src/components/HomepageFeatures.js @@ -6,36 +6,26 @@ const FeatureList = [ { title: 'Calendar', img: require('../../static/img/calendar.png').default, - description: ( - <> - Docusaurus was designed from the ground up to be easily installed and used to get your website up and running - quickly. - - ) + description: <>Calendar component }, { title: 'Calendar Markings', img: require('../../static/img/calendar-markings.png').default, - description: ( - <> - Docusaurus lets you focus on your docs, and we'll do the chores. Go ahead and move your docs into the{' '} - docs directory. - - ) + description: <>Marked dates on Calendar's components }, { title: 'Expandable Calendar', img: require('../../static/img/expandableCalendar.png').default, - description: ( - <> - Extend or customize your website layout by reusing React. Docusaurus can be extended while reusing the same - header and footer. - - ) + description: <>Expandable calendar component } + // { + // title: 'Timeline Calendar', + // img: require('../../static/img/timeline-calendar.png').default, + // description: (<>Timeline calendar component) + // } ]; -function Feature({img, title, description}) { +function Feature({img, title /* , description */}) { return (
diff --git a/docsRNC/src/css/custom.css b/docsRNC/src/css/custom.css index dd356b567e..cbe589da56 100644 --- a/docsRNC/src/css/custom.css +++ b/docsRNC/src/css/custom.css @@ -6,13 +6,13 @@ /* You can override the default Infima variables here. */ :root { - --ifm-color-primary: #ffae2f; - --ifm-color-primary-dark: #ffa416; - --ifm-color-primary-darker: #fb9900; - --ifm-color-primary-darkest: #e28a00; - --ifm-color-primary-light: #ffb849; - --ifm-color-primary-lighter: #ffc262; - --ifm-color-primary-lightest: #ffcc7c; + --ifm-color-primary: #ffb968; + --ifm-color-primary-dark: #ff9416; + --ifm-color-primary-darker: #ff9416; + --ifm-color-primary-darkest: #ff9416; + --ifm-color-primary-light: #ffdaae; + --ifm-color-primary-lighter: #ffdaae; + --ifm-color-primary-lightest: #ffdaae; --ifm-code-font-size: 95%; } diff --git a/docsRNC/src/pages/index.js b/docsRNC/src/pages/index.js index 66aec7c8af..279f82dd69 100644 --- a/docsRNC/src/pages/index.js +++ b/docsRNC/src/pages/index.js @@ -19,9 +19,8 @@ function HomepageHeader() { } export default function Home() { - const {siteConfig} = useDocusaurusContext(); return ( - +
diff --git a/docsRNC/src/pages/index.module.css b/docsRNC/src/pages/index.module.css index 666feb6a17..7099b4a77e 100644 --- a/docsRNC/src/pages/index.module.css +++ b/docsRNC/src/pages/index.module.css @@ -4,10 +4,11 @@ */ .heroBanner { - padding: 4rem 0; + padding: 6rem 0; text-align: center; position: relative; overflow: hidden; + height: 180px; } @media screen and (max-width: 966px) { diff --git a/docsRNC/static/img/RNC.png b/docsRNC/static/img/RNC.png deleted file mode 100644 index 748d9caf45..0000000000 Binary files a/docsRNC/static/img/RNC.png and /dev/null differ diff --git a/docsRNC/static/img/docusaurus.png b/docsRNC/static/img/docusaurus.png deleted file mode 100644 index f458149e3c..0000000000 Binary files a/docsRNC/static/img/docusaurus.png and /dev/null differ diff --git a/docsRNC/static/img/fav-icon.png b/docsRNC/static/img/fav-icon.png deleted file mode 100755 index ba97db035c..0000000000 Binary files a/docsRNC/static/img/fav-icon.png and /dev/null differ diff --git a/docsRNC/static/img/logo.png b/docsRNC/static/img/logo.png new file mode 100644 index 0000000000..c6ba5981b3 Binary files /dev/null and b/docsRNC/static/img/logo.png differ diff --git a/docsRNC/static/img/logo.svg b/docsRNC/static/img/logo.svg deleted file mode 100644 index 9db6d0d066..0000000000 --- a/docsRNC/static/img/logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docsRNC/static/img/timeline-calendar.png b/docsRNC/static/img/timeline-calendar.png new file mode 100644 index 0000000000..dfcab18176 Binary files /dev/null and b/docsRNC/static/img/timeline-calendar.png differ diff --git a/docsRNC/static/img/undraw_docusaurus_mountain.svg b/docsRNC/static/img/undraw_docusaurus_mountain.svg deleted file mode 100644 index 431cef2f7f..0000000000 --- a/docsRNC/static/img/undraw_docusaurus_mountain.svg +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docsRNC/static/img/undraw_docusaurus_react.svg b/docsRNC/static/img/undraw_docusaurus_react.svg deleted file mode 100644 index e417050433..0000000000 --- a/docsRNC/static/img/undraw_docusaurus_react.svg +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docsRNC/static/img/undraw_docusaurus_tree.svg b/docsRNC/static/img/undraw_docusaurus_tree.svg deleted file mode 100644 index a05cc03dda..0000000000 --- a/docsRNC/static/img/undraw_docusaurus_tree.svg +++ /dev/null @@ -1 +0,0 @@ -docu_tree \ No newline at end of file diff --git a/example/src/img/app-icon-120x120.png b/example/src/img/app-icon-120x120.png deleted file mode 100644 index efa18d0aa5..0000000000 Binary files a/example/src/img/app-icon-120x120.png and /dev/null differ diff --git a/example/src/img/logo.png b/example/src/img/logo.png new file mode 100644 index 0000000000..0677641590 Binary files /dev/null and b/example/src/img/logo.png differ diff --git a/example/src/screens/menu.tsx b/example/src/screens/menu.tsx index 20cd32b0b4..85e6629fe0 100644 --- a/example/src/screens/menu.tsx +++ b/example/src/screens/menu.tsx @@ -2,7 +2,8 @@ import React, {Component} from 'react'; import {Platform, StyleSheet, View, ScrollView, TouchableOpacity, Text, Image} from 'react-native'; import {Navigation} from 'react-native-navigation'; import testIDs from '../testIDs'; -import appIcon from '../img/app-icon-120x120.png'; + +const appIcon = require('../img/logo.png'); interface Props { componentId?: string; diff --git a/scripts/build-docs.js b/scripts/build-docs.js index e951687a35..632d292359 100644 --- a/scripts/build-docs.js +++ b/scripts/build-docs.js @@ -28,7 +28,7 @@ if (components) { if (component.extendsLink) { extendsText = `[${extendsText}](${component.extendsLink})`; } else { - const extendedComponentName = _.last(_.split(extendsText, '/')); // Incubator/TextField -> TextField + const extendedComponentName = _.last(_.split(extendsText, '/')); extendsText = `[${extendedComponentName}](/docs/${extendsText})`; } content += `:::info\n`; @@ -36,6 +36,11 @@ if (components) { content += `:::\n`; } + if (component.note) { + const noteText = component.note; + content += `**NOTE: ${noteText}**\n`; + } + /* Images */ content += `
`; component.images?.forEach(image => { diff --git a/src/expandableCalendar/WeekCalendar/weekCalendar.api.json b/src/expandableCalendar/WeekCalendar/weekCalendar.api.json index f98da79c49..15e696ffb3 100644 --- a/src/expandableCalendar/WeekCalendar/weekCalendar.api.json +++ b/src/expandableCalendar/WeekCalendar/weekCalendar.api.json @@ -2,6 +2,7 @@ "name": "WeekCalendar", "description": "Week calendar component", "images": [ + "https://github.com/wix/react-native-calendars/blob/master/demo/assets/week-calendar.gif?raw=true" ], "extends": ["CalendarList"], "extendsLink": [ diff --git a/src/expandableCalendar/agendaList.api.json b/src/expandableCalendar/agendaList.api.json index ae7a384f86..cd3efd6363 100644 --- a/src/expandableCalendar/agendaList.api.json +++ b/src/expandableCalendar/agendaList.api.json @@ -1,7 +1,9 @@ { "name": "AgendaList", - "description": "Agenda list component", + "description": "Agenda list component for the `ExpandableCalendar` component.", + "note": "This component should be wrapped with `CalendarProvider` component.", "images": [ + "https://github.com/wix/react-native-calendars/blob/master/demo/assets/expandable-calendar.gif?raw=true" ], "extends": ["FlatList"], "extendsLink": [ diff --git a/src/expandableCalendar/expandableCalendar.api.json b/src/expandableCalendar/expandableCalendar.api.json index b49fae913b..9d40f2c07e 100644 --- a/src/expandableCalendar/expandableCalendar.api.json +++ b/src/expandableCalendar/expandableCalendar.api.json @@ -1,7 +1,9 @@ { "name": "ExpandableCalendar", "description": "Expandable calendar component", + "note": "This component should be wrapped with `CalendarProvider` component.", "images": [ + "https://github.com/wix/react-native-calendars/blob/master/demo/assets/expandable-calendar.gif?raw=true" ], "extends": ["CalendarList"], "extendsLink": [ diff --git a/src/timeline/timeline.api.json b/src/timeline/timeline.api.json index 63dafca57f..e12efd5b87 100644 --- a/src/timeline/timeline.api.json +++ b/src/timeline/timeline.api.json @@ -1,7 +1,9 @@ { "name": "Timeline", "description": "Timeline component", - "images": [], + "images": [ + "https://github.com/wix/react-native-calendars/blob/master/demo/assets/timeline-calendar.gif?raw=true" + ], "extends": ["ScrollView"], "extendsLink": ["https://reactnative.dev/docs/scrollview"], "example": "https://github.com/wix/react-native-calendars/blob/master/example/src/screens/timelineCalendar.tsx",