Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.11.x #20

Merged
7 commits merged into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/react-front-kit-table/table-grid-view.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import Description from '../../src/components/Description/Description';
extendsInfo={[
{
label: 'SwitchableView',
link: './switchable-view',
link: '../react-front-kit/components/switchable-view',
logo: <GitHubLogo />,
},
]}
Expand Down
51 changes: 51 additions & 0 deletions docs/react-front-kit/components/calendar-header.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import { GitHubLogo } from '../../../src/icons/GitHubLogo';

# Calendar Header

<Description
extendsInfo={[
{
label: 'CalendarHeader',
link: 'https://github.com/mantinedev/mantine/blob/master/packages/%40mantine/dates/src/components/CalendarHeader/CalendarHeader.tsx',
},
]}
importExample="import { CalendarHeader } from '@smile/react-front-kit';"
packageInfo={{
label: '@smile/react-front-kit',
link: 'https://www.npmjs.com/package/@smile/react-front-kit',
}}
sourceInfo={{
link: 'https://github.com/Smile-SA/react-front-kit/blob/main/packages/react-front-kit/src/Components/CalendarHeader/CalendarHeader.tsx',
}}
storybookInfo="3-custom-components-calendarheader--docs"
>
Display a controlled calendar header with 3 levels of precision: Year, Day,
and Decade. The component is based on a component
[CalendarHeader](https://github.com/mantinedev/mantine/blob/master/packages/%40mantine/dates/src/components/CalendarHeader/CalendarHeader.tsx)
he is not shown in the documentation but visible in the library's code.
</Description>

## Storybook Docs

<StorybookEmbed
storyId="3-custom-components-calendarheader--docs"
height="1780"
/>

## Props

| Name | Type | Default | Description |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| date <Required/> | `Date` | - | Value given to define the date displayed on the calendarHeader |
| level <Required/> | [`ICalendarHeaderClickType`](#icalendarheaderclicktype) | - | Defines the date level to display in the header modal |
| onDateClick | `((event: MouseEvent<HTMLButtonElement, MouseEvent>, date: Date, level: `[`ICalendarHeaderClickType`](#icalendarheaderclicktype)` ) => void)` | - | Returns a callback function that provides the value of the date that has just been clicked and the current level |
| monthProps | `Omit<MonthProps, "month">` | - | Allows configuring the props of the Month component from Mantine. |
| monthListProps | `Omit<MonthsListProps, "year">` | - | Allows configuring the props of the MonthList component from Mantine. |
| yearsListProps | `Omit<YearsListProps, "decade">` | - | Allows configuring the props of the YearsList component from Mantine. |
| ... | - | - | extends [`CalendarHeader props`](https://github.com/mantinedev/mantine/blob/master/packages/%40mantine/dates/src/components/CalendarHeader/CalendarHeader.tsx) |

## ICalendarHeaderClickType

| Type | Description |
| ------------------------------- | ---------------------------------------------------- |
| `"month" \| "year" \| "decade"` | Value of the click location's level of localization. |
37 changes: 37 additions & 0 deletions docs/react-front-kit/components/data-badge.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Data Badge

<Description
extendsInfo={[
{
label: 'Badge',
link: 'https://mantine.dev/core/badge/',
},
]}
importExample="import { DataBadge } from '@smile/react-front-kit';"
packageInfo={{
label: '@smile/react-front-kit',
link: 'https://www.npmjs.com/package/@smile/react-front-kit',
}}
sourceInfo={{
link: 'https://github.com/Smile-SA/react-front-kit/blob/main/packages/react-front-kit/src/Components/DataBadge/DataBadge.tsx',
}}
storybookInfo="3-custom-components-databadge--docs"
>
Display a badge that spans the entire width of the parent component with a
number field and text. There are two types of displays: large and medium.
</Description>

## Storybook Docs

<StorybookEmbed storyId="3-custom-components-databadge--docs" height="1180" />

## Props

| Name | Type | Default | Description |
| -------- | --------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| children | `string` | - | The text is displayed to the right of the number. |
| color | `DefaultMantineColor` | - | The color applied to the badge, and the contrast is automatically managed by the `autoContrast` prop of the `Badge` component. If the prop is not specified, the text color will be black, and there will be no `backgroundColor`. |
| number | `number` | - | The number value is displayed to the left of the text. The `fit-content` property and a `margin-right` are applied to the number tag. |
| size | `"lg" \| "md"` | `"md"` | Controls the appearance of the component. Allows switching between two templates: `"md"` and `"lg"`. |
| ratio | `number ` | - | Manages the default width size of the number tag. |
| ... | - | - | extends [`Badge props`](https://mantine.dev/core/badge/) |
2 changes: 1 addition & 1 deletion docs/react-front-kit/components/document-box.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

## Storybook Docs

<StorybookEmbed storyId="3-custom-components-documentbox---docs" height="950" />
<StorybookEmbed storyId="3-custom-components-documentbox--docs" height="950" />

## Props

Expand Down
2 changes: 1 addition & 1 deletion docs/react-front-kit/components/event-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import { GitHubLogo } from '../../../src/icons/GitHubLogo';

## Storybook Docs

<StorybookEmbed storyId="3-custom-components-EventList--docs" height="820" />
<StorybookEmbed storyId="3-custom-components-eventlist--docs" height="820" />

## Props

Expand Down
38 changes: 38 additions & 0 deletions docs/react-front-kit/components/icon-card.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Icon card

<Description
extendsInfo={[
{
label: 'Card',
link: 'https://mantine.dev/core/card/',
},
]}
importExample="import { IconCard } from '@smile/react-front-kit';"
packageInfo={{
label: '@smile/react-front-kit',
link: 'https://www.npmjs.com/package/@smile/react-front-kit',
}}
sourceInfo={{
link: 'https://github.com/Smile-SA/react-front-kit/blob/main/packages/react-front-kit/src/Components/IconCard/IconCard.tsx',
}}
storybookInfo="3-custom-components-iconcard--docs"
>
Renders a horizontal bar displaying the number of selected elements and an
array of [`IAction`s](../../shared-types/actions#iactiont) as
[ActionIcons](https://v6.mantine.dev/core/action-icon/)
</Description>

## Storybook Docs

<StorybookEmbed storyId="3-custom-components-iconcard--docs" height="2020" />

## Props

| Name | Type | Default | Description |
| -------- | ----------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| children | `ReactNode` | - | Free area in the lower zone of the map |
| icon | `ReactNode` | - | Area in the top of the map primarily used for displaying icons but can show anything that corresponds to the ReactNode type |
| subTitle | `ReactNode` | - | SubTitle area |
| title | `ReactNode` | - | TItle area |
| color | `string` | - | Define the background color of the card. By default, the primary color is applied. Auto-contrast is used to automatically change the text color |
| ... | - | - | extends [`card props`](https://mantine.dev/core/card/?t=props). |
5 changes: 4 additions & 1 deletion docs/react-front-kit/components/menu-languages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ import { GitHubLogo } from '../../../src/icons/GitHubLogo';

## Storybook Docs

<StorybookEmbed storyId="3-custom-components-MenuLanguages" height="820" />
<StorybookEmbed
storyId="3-custom-components-menulanguages--docs"
height="820"
/>

## Props

Expand Down
2 changes: 1 addition & 1 deletion docs/react-front-kit/components/summary-box.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

## Storybook Docs

<StorybookEmbed storyId="3-custom-components-summarybox---docs" height="950" />
<StorybookEmbed storyId="3-custom-components-summarybox--docs" height="950" />

## Props

Expand Down
7 changes: 7 additions & 0 deletions docs/react-front-kit/form/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "Form",
"position": 3,
"link": {
"type": "generated-index"
}
}
46 changes: 46 additions & 0 deletions docs/react-front-kit/form/full-name-fields.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Full Name Fields

<Description
extendsInfo={[
{
label: 'Flex',
link: 'https://mantine.dev/core/flex/',
},
{
label: 'TextInput',
link: 'https://mantine.dev/core/text-input/',
},
]}
importExample="import { FullNameFields } from '@smile/react-front-kit';"
packageInfo={{
label: '@smile/react-front-kit',
link: 'https://www.npmjs.com/package/@smile/react-front-kit',
}}
sourceInfo={{
link: 'https://github.com/Smile-SA/react-front-kit/blob/main/packages/react-front-kit/src/Components/FullNameFields/FullNameFields.tsx',
}}
>
Displaying a grouped input with first name and last name, usable in a
controlled manner.
</Description>

## Storybook Docs

<StorybookEmbed storyId="3-custom-form-fullnamefields--docs" height="820" />

## Props

| Name | Type | Default | Description |
| -------------- | ---------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| firstNameProps | [`TextInputProps`](https://mantine.dev/core/text-input/?t=props) | - | extends [`text input props`](https://mantine.dev/core/text-input/) If configured, the changes will apply to the firstName input |
| lastNameProps | [`TextInputProps`](https://mantine.dev/core/text-input/?t=props) | - | extends [`text input props`](https://mantine.dev/core/text-input/) If configured, the changes will apply to the lastName input |
| onChange | `((value: IFullNameFieldsValues) => void)` | - | Callback function returning the value of the input that has just been changed |
| value | `IFullNameFieldsValues` | - | Allows setting the values of the two text input fields |
| ... | - | - | extends [`flex props`](https://mantine.dev/core/flex/?t=props) |

## IFullNameFieldsValues

| Name | Type | Default | Description |
| --------- | -------- | ------- | -------------------------- |
| firstName | `string` | - | Value of `firstName` field |
| lastName | `string` | - | Value of `lastName` field |
Loading