docs: unify prop generation (#3996)

* docs: improve props generation a bit * optimize * adjust api of props table
marigold-ui · Jul 11, 2024 · 7771625 · 7771625
1 parent ed3bd89
commit 7771625
Show file tree

Hide file tree

Showing 60 changed files with 132 additions and 184,223 deletions.
diff --git a/docs/.component-props/index.json b/docs/.component-props/index.json
diff --git a/docs/content/components/application/provider/provider.mdx b/docs/content/components/application/provider/provider.mdx
@@ -1,5 +1,5 @@
 ---
-title: Provider
+title: MarigoldProvider
 caption: Provider which applies the theme.
 ---
 
@@ -25,7 +25,7 @@ import { MarigoldProvider } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="MarigoldProvider.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/application/routerprovider/routerprovider.mdx b/docs/content/components/application/routerprovider/routerprovider.mdx
@@ -14,7 +14,7 @@ import { RouterProvider } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="RouterProvider.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/collection/accordion/accordion.mdx b/docs/content/components/collection/accordion/accordion.mdx
@@ -22,11 +22,11 @@ import { Accordion } from '@marigold/components';
 
 ### Accordion
 
-<PropsTable componentFile="Accordion.tsx" />
+<PropsTable component={title} />
 
 ### Accordion.Item
 
-<PropsTable componentFile="AccordionItem.tsx" />
+<PropsTable component="AccordionItem" />
 
 ## Examples
 

diff --git a/docs/content/components/collection/selectlist/selectlist.mdx b/docs/content/components/collection/selectlist/selectlist.mdx
@@ -17,11 +17,11 @@ import { SelectList } from '@marigold/components';
 
 ### SelectList
 
-<PropsTable componentFile="SelectList.tsx" />
+<PropsTable component={title} />
 
 ### SelectList.Item
 
-<PropsTable componentFile="SelectListItem.tsx" />
+<PropsTable component="SelectListItem" />
 
 ## Examples
 

diff --git a/docs/content/components/collection/table/table.mdx b/docs/content/components/collection/table/table.mdx
@@ -23,27 +23,27 @@ import { Table } from '@marigold/components';
 
 ### Table
 
-<PropsTable componentFile="Table.tsx" />
+<PropsTable component={title} />
 
 ### Table.Header
 
 <PropsTable />
 
 ### Table.Column
 
-<PropsTable componentFile="TableColumnHeader.tsx" />
+<PropsTable component="TableColumnHeader" />
 
 ### Table.Body
 
-<PropsTable componentFile="TableBody.tsx" />
+<PropsTable component="TableBody" />
 
 ### Table.Row
 
-<PropsTable componentFile="TableRow.tsx" />
+<PropsTable component="TableRow" />
 
 ### Table.Cell
 
-<PropsTable />
+<PropsTable component="TableCell" />
 
 ## Examples
 

diff --git a/docs/content/components/collection/tag/tag.mdx b/docs/content/components/collection/tag/tag.mdx
@@ -19,9 +19,15 @@ import { Tag } from '@marigold/components';
 
 <AppearanceTable component={title} />
 
-### Group props
+## Props
 
-<PropsTable componentFile="TagGroup.tsx" />
+### Tag
+
+<PropsTable component={title} />
+
+### Tag.Group
+
+<PropsTable component="TagGroup" />
 
 ## Examples
 

diff --git a/docs/content/components/content/badge/badge.mdx b/docs/content/components/content/badge/badge.mdx
@@ -17,7 +17,7 @@ import { Badge } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="Badge.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/content/card/card.mdx b/docs/content/components/content/card/card.mdx
@@ -21,7 +21,7 @@ import { Card } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="Card.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/content/headline/headline.mdx b/docs/content/components/content/headline/headline.mdx
@@ -23,7 +23,7 @@ import { Headline } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="Headline.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/content/icon/icon.mdx b/docs/content/components/content/icon/icon.mdx
@@ -37,7 +37,7 @@ Alternatively you can go to [Marigold Icons](/concepts/icons/) and click on an I
 
 ## Props
 
-<PropsTable componentFile="SVG.tsx" />
+<PropsTable component="SVG" />
 
 ## Examples
 

diff --git a/docs/content/components/content/image/image.mdx b/docs/content/components/content/image/image.mdx
@@ -24,7 +24,7 @@ import { Image } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="Image.tsx" />
+<PropsTable component={title} />
 
 ## Usage
 

diff --git a/docs/content/components/content/link/link.mdx b/docs/content/components/content/link/link.mdx
@@ -18,7 +18,7 @@ import { Link } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="Link.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/content/list/list.mdx b/docs/content/components/content/list/list.mdx
@@ -22,7 +22,7 @@ import { List } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="List.tsx" />
+<PropsTable component={title} />
 
 ## Usage
 

diff --git a/docs/content/components/content/section-message/section-message.mdx b/docs/content/components/content/section-message/section-message.mdx
@@ -24,7 +24,7 @@ import { SectionMessage } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="SectionMessage.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/content/svg/svg.mdx b/docs/content/components/content/svg/svg.mdx
@@ -15,7 +15,7 @@ import { SVG } from '@marigold/system';
 
 ## Props
 
-<PropsTable componentFile="SVG.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/content/text/text.mdx b/docs/content/components/content/text/text.mdx
@@ -19,7 +19,7 @@ import { Text } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="Text.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/content/visually-hidden/visually-hidden.mdx b/docs/content/components/content/visually-hidden/visually-hidden.mdx
@@ -15,7 +15,7 @@ import { VisuallyHidden } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="VisuallyHidden.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/content/xloader/xloader.mdx b/docs/content/components/content/xloader/xloader.mdx
@@ -20,7 +20,7 @@ import { XLoader } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="XLoader.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/form/autocomplete/autocomplete.mdx b/docs/content/components/form/autocomplete/autocomplete.mdx
@@ -21,11 +21,11 @@ import { Autocomplete } from '@marigold/components';
 
 ### Autocomplete
 
-<PropsTable componentFile="Autocomplete.tsx" />
+<PropsTable component={title} />
 
 ### Autocomplete.Item
 
-<PropsTable componentFile="ListBoxOption.tsx" />
+<PropsTable component="ListBoxOption" />
 
 ## Examples
 

diff --git a/docs/content/components/form/button/button.mdx b/docs/content/components/form/button/button.mdx
@@ -20,7 +20,7 @@ import { Button } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="Button.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/form/calendar/calendar.mdx b/docs/content/components/form/calendar/calendar.mdx
@@ -19,7 +19,7 @@ import { Calendar } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="Calendar.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/form/checkbox/checkbox.mdx b/docs/content/components/form/checkbox/checkbox.mdx
@@ -23,11 +23,11 @@ import { Checkbox, CheckboxGroup } from '@marigold/components';
 
 ### Checkbox
 
-<PropsTable componentFile="Checkbox.tsx" />
+<PropsTable component={title} />
 
 ### Checkbox.Group
 
-<PropsTable componentFile="CheckboxGroup.tsx" />
+<PropsTable component="CheckboxGroup" />
 
 ## Examples
 

diff --git a/docs/content/components/form/combobox/combobox.mdx b/docs/content/components/form/combobox/combobox.mdx
@@ -21,11 +21,11 @@ import { ComboBox } from '@marigold/components';
 
 ### ComboBox
 
-<PropsTable componentFile="ComboBox.tsx" />
+<PropsTable component={title} />
 
 ### ComboBox.Item
 
-<PropsTable componentFile="ListBoxOption.tsx" />
+<PropsTable component="ListBoxOption" />
 
 ## Examples
 

diff --git a/docs/content/components/form/datefield/datefield.mdx b/docs/content/components/form/datefield/datefield.mdx
@@ -19,7 +19,7 @@ import { DateField } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="DateField.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/form/datepicker/datepicker.mdx b/docs/content/components/form/datepicker/datepicker.mdx
@@ -19,7 +19,7 @@ import { DatePicker } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="DatePicker.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/form/fieldgroup/field-group.mdx b/docs/content/components/form/fieldgroup/field-group.mdx
@@ -24,7 +24,7 @@ import { FieldGroup } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="FieldGroup.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/form/form/form.mdx b/docs/content/components/form/form/form.mdx
@@ -19,7 +19,7 @@ import { Form } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="Form.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/form/number-field/number-field.mdx b/docs/content/components/form/number-field/number-field.mdx
@@ -21,7 +21,7 @@ import { NumberField } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="NumberField.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/form/radio/radio.mdx b/docs/content/components/form/radio/radio.mdx
@@ -21,11 +21,11 @@ import { Radio } from '@marigold/components';
 
 ### Radio
 
-<PropsTable componentFile="Radio.tsx" />
+<PropsTable component={title} />
 
 ### Radio.Group
 
-<PropsTable componentFile="RadioGroup.tsx" />
+<PropsTable component="RadioGroup" />
 
 ## Examples
 

diff --git a/docs/content/components/form/search-field/search-field.mdx b/docs/content/components/form/search-field/search-field.mdx
@@ -19,7 +19,7 @@ import { SearchField } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="SearchField.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/form/select/select.mdx b/docs/content/components/form/select/select.mdx
@@ -21,15 +21,15 @@ import { Select } from '@marigold/components';
 
 ### Select
 
-<PropsTable componentFile="Select.tsx" />
+<PropsTable component={title} />
 
 ### Select.Section
 
-<PropsTable componentFile="ListBoxSection.tsx" />
+<PropsTable component="ListBoxSection" />
 
 ### Select.Option
 
-<PropsTable componentFile="ListBoxOption.tsx" />
+<PropsTable component="ListBoxOption" />
 
 ## Examples
 

diff --git a/docs/content/components/form/slider/slider.mdx b/docs/content/components/form/slider/slider.mdx
@@ -19,7 +19,7 @@ import { Slider } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="Slider.tsx" />
+<PropsTable component="Slider.tsx" />
 
 ## Examples
 

diff --git a/docs/content/components/form/switch/switch.mdx b/docs/content/components/form/switch/switch.mdx
@@ -22,7 +22,7 @@ import { Switch } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="Switch.tsx" />
+<PropsTable component="Switch.tsx" />
 
 ## Examples
 

diff --git a/docs/content/components/form/text-area/text-area.mdx b/docs/content/components/form/text-area/text-area.mdx
@@ -21,7 +21,7 @@ import { TextArea } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="TextArea.tsx" />
+<PropsTable component={title} />
 
 ## Examples
 

diff --git a/docs/content/components/form/textfield/textfield.mdx b/docs/content/components/form/textfield/textfield.mdx
@@ -21,7 +21,7 @@ import { TextField } from '@marigold/components';
 
 ## Props
 
-<PropsTable componentFile="TextField.tsx" />
+<PropsTable component={title} />
 
 ## Examples