Add "note" to buid-docs

Author: Inbal-Tish

docsRNC/docs/AgendaList.md

@@ -1,8 +1,9 @@
-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.**
 
 <div style={{display: 'flex', flexDirection: 'row', overflowX: 'auto', maxHeight: '500px', alignItems: 'center'}}></div>
 

docsRNC/docs/ExpandableCalendar.md

@@ -3,6 +3,7 @@ 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.**
 
 <div style={{display: 'flex', flexDirection: 'row', overflowX: 'auto', maxHeight: '500px', alignItems: 'center'}}></div>
 

scripts/build-docs.js

@@ -28,14 +28,19 @@ 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`;
       content += `This component extends **${extendsText}** props.\n`;
       content += `:::\n`;
     }
 
+    if (component.note) {
+      const noteText = component.note;
+      content += `**NOTE: ${noteText}**\n`;
+    }
+
     /* Images */
     content += `<div style={{display: 'flex', flexDirection: 'row', overflowX: 'auto', maxHeight: '500px', alignItems: 'center'}}>`;
     component.images?.forEach(image => {

src/expandableCalendar/agendaList.api.json

@@ -1,6 +1,7 @@
 {
   "name": "AgendaList",
-  "description": "Agenda list component",
+  "description": "Agenda list component for the `ExpandableCalendar` component.",
+  "note": "This component should be wrapped with `CalendarProvider` component.",
   "images": [
   ],
   "extends": ["FlatList"],

src/expandableCalendar/expandableCalendar.api.json

@@ -1,6 +1,7 @@
 {
   "name": "ExpandableCalendar",
   "description": "Expandable calendar component",
+  "note": "This component should be wrapped with `CalendarProvider` component.",
   "images": [
   ],
   "extends": ["CalendarList"],