Skip to content

Commit

Permalink
fix: broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
Quentin LE CAIGNEC committed Sep 5, 2024
1 parent 8f742f8 commit 61304db
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 27 deletions.
6 changes: 2 additions & 4 deletions docs/haring-react/form/address-gouv-autocomplete-field.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
}}
>
An autocomplete field which is a [`FetchAutocompleteField
Props`](./FetchAutocompleteField) component configured for the
Props`](./fetch-autocomplete-field) component configured for the
[`api-Adresse.data.gouv`](https://adresse.data.gouv.fr/).
</Description>

Expand All @@ -36,12 +36,10 @@
| lon | `string` | `''` | To be filled in to prioritize these longitude coordinates in the search results. |
| type | `string` | `''` | To be filled in to reduce to specific type of results of the search. |
| onFetchData | `(value: string) => Promise<IValue<IAddressGouvData>[]>` | `A default function getDataAddressGouv that makes a call to the api-adresse.gouv.fr API.` | This callback function return field value to the parameters and to be return `Promise<IValue<IAddressGouvData>[]>` value. By default this props is defined. |
| ... | - | - | extends [`FetchAutocompleteField Props`](./FetchAutocompleteField/#props) |
| ... | - | - | extends [`FetchAutocompleteField Props`](./fetch-autocomplete-field/#props) |

## IAddressGouvData

IAddressGouvData contain `properties` object with thats types:

| name | type | Description |
| ----------- | -------- | ---------------------- |
| city | `string` | Name of the city |
Expand Down
46 changes: 23 additions & 23 deletions docs/haring-react/form/dynamic-zone.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,32 +30,32 @@ Buttons at the bottom can be clicked to add new blocks into the zone, each block

DynamicZone takes a `<Block>` generic type that extends `IBaseBlock`.

| Name | Type | Default | Description |
| -------------------------------- | --------------------------------------------------------------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- |
| blockOptions <Required/> | [`IBaseBlockButton`](#ibaseblockbutton)`[]` | - | Array of `IBaseBlockButton`, displays as buttons to add blocks at the bottom of the zone |
| blocks <Required/> | `Block[]` | - | Array of `Block`, displays as list of [`DynamicZoneBlock`](#dynamic-zone-block) |
| onAppendBlock <Required/> | `(blockType: string) => void` | - | Callback function called when a block button is clicked to append a new block |
| onRenderBlockContent <Required/> | `(block: Block, index: number) => ReactElement` | - | Callback function called when a block is being rendered in the list, parent needs to return the rendered content |
| onToggleBlock <Required/> | `(block: Block, index: number, opened: boolean) => void` | - | Callback function called when a block's toggle button is clicked to open/close it |
| blockCardProps | [`CardProps`](https://mantine.dev/core/card/?t=props) | - | Extra props for the internal [Card](https://mantine.dev/core/card/) component, root of [`DynamicZoneBlock`](#dynamic-zone-block) |
| blocksStackProps | [`StackProps`](https://mantine.dev/core/stack/?t=props) | - | Extra props for the internal [Stack](https://mantine.dev/core/stack/) component, child of the root Container |
| bottomContainerProps | [`ContainerProps`](https://mantine.dev/core/container/?t=props) | - | Extra props for the internal [Container](https://mantine.dev/core/container/) component, child of the root Container |
| buttonsGroupProps | [`GroupProps`](https://mantine.dev/core/group/?t=props) | - | Extra props for the internal [Group](https://mantine.dev/core/group/) component, container of the button area |
| buttonsText | `string` | - | Content of button area's optional header, inside a [Text](https://mantine.dev/core/text/) component |
| buttonsTextProps | [`TextProps`](https://mantine.dev/core/text/?t=props) | - | Extra props for the internal [Text](https://mantine.dev/core/text/) component, container of the button area's optional header |
| internalBlockCardProps | [`IDynamicZoneBlockInternalComponentProps`](./dynamic-zone-block#idynamiczoneblockinternalcomponentprops) | - | Extra internal component props passed to [`DynamicZoneBlock`](#dynamic-zone-block) |
| ... | - | - | extends [`Container Props`](https://mantine.dev/core/container/?t=props), root container |
| Name | Type | Default | Description |
| -------------------------------- | ------------------------------------------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- |
| blockOptions <Required/> | [`IBaseBlockButton`](#ibaseblockbutton)`[]` | - | Array of `IBaseBlockButton`, displays as buttons to add blocks at the bottom of the zone |
| blocks <Required/> | `Block[]` | - | Array of `Block`, displays as list of [`DynamicZoneBlock`](#dynamic-zone-block) |
| onAppendBlock <Required/> | `(blockType: string) => void` | - | Callback function called when a block button is clicked to append a new block |
| onRenderBlockContent <Required/> | `(block: Block, index: number) => ReactElement` | - | Callback function called when a block is being rendered in the list, parent needs to return the rendered content |
| onToggleBlock <Required/> | `(block: Block, index: number, opened: boolean) => void` | - | Callback function called when a block's toggle button is clicked to open/close it |
| blockCardProps | [`CardProps`](https://mantine.dev/core/card/?t=props) | - | Extra props for the internal [Card](https://mantine.dev/core/card/) component, root of [`DynamicZoneBlock`](#dynamic-zone-block) |
| blocksStackProps | [`StackProps`](https://mantine.dev/core/stack/?t=props) | - | Extra props for the internal [Stack](https://mantine.dev/core/stack/) component, child of the root Container |
| bottomContainerProps | [`ContainerProps`](https://mantine.dev/core/container/?t=props) | - | Extra props for the internal [Container](https://mantine.dev/core/container/) component, child of the root Container |
| buttonsGroupProps | [`GroupProps`](https://mantine.dev/core/group/?t=props) | - | Extra props for the internal [Group](https://mantine.dev/core/group/) component, container of the button area |
| buttonsText | `string` | - | Content of button area's optional header, inside a [Text](https://mantine.dev/core/text/) component |
| buttonsTextProps | [`TextProps`](https://mantine.dev/core/text/?t=props) | - | Extra props for the internal [Text](https://mantine.dev/core/text/) component, container of the button area's optional header |
| internalBlockCardProps | [`IDynamicZoneBlockInternalComponentProps`](#idynamiczoneblockinternalcomponentprops) | - | Extra internal component props passed to [`DynamicZoneBlock`](#dynamic-zone-block) |
| ... | - | - | extends [`Container Props`](https://mantine.dev/core/container/?t=props), root container |

## `IBaseBlock`

| Name | Type | Default | Description |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| id <Required/> | `string` | - | Used internally as keys and for other reasons, should be unique and not be modified once set |
| opened <Required/> | `boolean` | - | Controlled value that determines if the block is opened or not |
| blockType <Required/> | `string` | - | Type of the block being rendered, sent back to parent for render, used as a kind of block type ID here and in IBaseBlockButton |
| blockHeader <Required/> | `ReactNode` | - | Content of the block header |
| blockFooter | `ReactNode` | - | Content of the block footer |
| blockActions | [`IAction`](../../shared-types/actions#iactiont)`<`[`IDynamicZoneBlockReference`](./dynamic-zone-block#idynamiczoneblockreference)`>[]` | - | Action(s) displayed to the right of the block header |
| Name | Type | Default | Description |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| id <Required/> | `string` | - | Used internally as keys and for other reasons, should be unique and not be modified once set |
| opened <Required/> | `boolean` | - | Controlled value that determines if the block is opened or not |
| blockType <Required/> | `string` | - | Type of the block being rendered, sent back to parent for render, used as a kind of block type ID here and in IBaseBlockButton |
| blockHeader <Required/> | `ReactNode` | - | Content of the block header |
| blockFooter | `ReactNode` | - | Content of the block footer |
| blockActions | [`IAction`](../../shared-types/actions#iactiont)`<`[`IDynamicZoneBlockReference`](#idynamiczoneblockreference)`>[]` | - | Action(s) displayed to the right of the block header |

## `IBaseBlockButton`

Expand Down

0 comments on commit 61304db

Please sign in to comment.