Skip to content

Fix Modal.stories.tsx code documentation #97

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 31, 2023
Merged

Fix Modal.stories.tsx code documentation #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d9a594
Fix `Modal.stories.tsx` code documentation
nkokla Mar 28, 2023
9d91944
Update `Modal.stories.tsx` code documentation
nkokla Mar 29, 2023
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
30 changes: 27 additions & 3 deletions stories/Modal.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,30 @@ const { meta, getStory } = getStoryFactory({
This is a uncontrolled implementation of the modal, compatible with Server Components.
An controlled variant is coming soon.

## The 'createModal' function

The \`createModal(options)\` function take an \`options\` object as parameter.

**Options Params keys:**
- \`name\` (*STRING - Required*): Prefix of the \`Modal\` component name and \`ModalButtonProps\` object name.
- \`isOpenedByDefault\` (*BOOLEAN - Required*): Set the opening state of the Modal after it mount.

**Return:**
An object with two keys. The name of these keys are computed from the value
of \`name\` key of the \`options\` param object :
- \`\${PascalCasePrefix}Modal\`: The Modal component
- \`\${camelCasePrefix}ModalButtonProps\`: The props object for \`Button\` DSFR component

**Eg.:**
\`\`\`
const { MyComponentModal, myComponentButtonProps } = createModal({
name: "myComponent", // The name of Modal component and modalButtonProps is compute from this string
isOpenedByDefault: false
});
\`\`\`

## The Modal component

`,
"argTypes": {
"title": {
Expand Down Expand Up @@ -115,10 +139,10 @@ Default.parameters = {
import { createModal } from "@codegouvfr/react-dsfr/Modal";
import { Button } from "@codegouvfr/react-dsfr/Button";

const { AcceptTermsModal, acceptTermsModalButtonProps } = createModal(
name: "simple",
const { AcceptTermsModal, acceptTermsModalButtonProps } = createModal({
name: "acceptTerms",
isOpenedByDefault: false
);
});

function MyComponent(){

Expand Down