feat(richtext): fixes comments in Props to display in storybook

Fix PR #93
HospitalRun · Nov 19, 2019 · fa1e526 · fa1e526
1 parent 3e8c3a4
commit fa1e526
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 34 deletions.
diff --git a/src/components/RichText/RichText.tsx b/src/components/RichText/RichText.tsx
@@ -17,15 +17,30 @@ import 'tinymce/plugins/paste/plugin.min'
 import 'tinymce/plugins/charmap/plugin.min'
 
 interface Props {
-  // id of the rich text editor component
+  /**
+   * id of the rich text editor component
+   * @default ""
+   */
   id?: string
-  // Initial value of the rich text editor
+  /**
+   *  Initial value of the rich text editor
+   * @default ""
+   */
   value?: string
-  // Defines whether the rich text editor should be enabled/disabled (default = false)
+  /**
+   * Defines whether the rich text editor should be enabled/disabled (default = false)
+   * @default ""
+   */
   disabled?: boolean
-  // Height of the rich text editor
+  /**
+   * Height of the rich text editor
+   * @default 500
+   */
   height?: number
-  // Method run on the editors onEditorChange event. Returns editor content as HTML.
+  /**
+   * Method run on the editors onEditorChange event. Returns editor content as HTML.
+   * @default null
+   */
   onChange?: (event: React.KeyboardEvent<HTMLTextAreaElement>) => void
 }
 

diff --git a/src/helpers/controlSize.ts b/src/helpers/controlSize.ts
@@ -3,10 +3,7 @@ interface KeyValuePair {
   value: any
 }
 
-const sizes: KeyValuePair[] = [
-  { key: 'small', value: 'sm' },
-  { key: 'large', value: 'lg' },
-]
+const sizes: KeyValuePair[] = [{ key: 'small', value: 'sm' }, { key: 'large', value: 'lg' }]
 
 export function getControlSize(size: string | undefined): 'sm' | 'lg' | undefined {
   const controlSize = sizes.find((s) => s.key === size)

diff --git a/stories/graphs.stories.tsx b/stories/graphs.stories.tsx
@@ -16,11 +16,7 @@ storiesOf('Graphs', module)
         {
           backgroundColor: 'blue',
           label: 'Months',
-          data: [
-            { x: 'January', y: 12 },
-            { x: 'February', y: 11 },
-            { x: 'March', y: 10 },
-          ],
+          data: [{ x: 'January', y: 12 }, { x: 'February', y: 11 }, { x: 'March', y: 10 }],
         },
       ]}
       xAxes={[{ label: 'Months', type: 'category' }]}
@@ -35,11 +31,7 @@ storiesOf('Graphs', module)
         {
           backgroundColor: 'blue',
           label: 'Months',
-          data: [
-            { x: 'January', y: 12 },
-            { x: 'February', y: 11 },
-            { x: 'March', y: 10 },
-          ],
+          data: [{ x: 'January', y: 12 }, { x: 'February', y: 11 }, { x: 'March', y: 10 }],
         },
       ]}
       xAxes={[{ label: 'Months', type: 'category' }]}
@@ -54,11 +46,7 @@ storiesOf('Graphs', module)
           borderColor: 'red',
           backgroundColor: 'blue',
           label: 'Months',
-          data: [
-            { x: 'January', y: 12 },
-            { x: 'February', y: 11 },
-            { x: 'March', y: 10 },
-          ],
+          data: [{ x: 'January', y: 12 }, { x: 'February', y: 11 }, { x: 'March', y: 10 }],
         },
       ]}
       xAxes={[{ label: 'Months', type: 'category' }]}

diff --git a/test/bargraph.test.tsx b/test/bargraph.test.tsx
@@ -11,11 +11,7 @@ describe('BarGraph', () => {
           {
             backgroundColor: 'blue',
             label: 'Months',
-            data: [
-              { x: 'January', y: 12 },
-              { x: 'February', y: 11 },
-              { x: 'March', y: 10 },
-            ],
+            data: [{ x: 'January', y: 12 }, { x: 'February', y: 11 }, { x: 'March', y: 10 }],
           },
         ]}
         xAxes={[{ label: 'Months', type: 'category' }]}

diff --git a/test/linegraph.test.tsx b/test/linegraph.test.tsx
@@ -12,11 +12,7 @@ describe('LineGraph', () => {
             borderColor: 'red',
             backgroundColor: 'blue',
             label: 'Months',
-            data: [
-              { x: 'January', y: 12 },
-              { x: 'February', y: 11 },
-              { x: 'March', y: 10 },
-            ],
+            data: [{ x: 'January', y: 12 }, { x: 'February', y: 11 }, { x: 'March', y: 10 }],
           },
         ]}
         xAxes={[{ label: 'Months', type: 'category' }]}