Skip to content

[Style Guide] Added note on how to use markdown with optional params #23421

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 1 commit into from
Jul 3, 2025
Merged

[Style Guide] Added note on how to use markdown with optional params #23421

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions src/content/docs/style-guide/components/render.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,17 @@ params:
---
```

:::caution
If you use the Markdown component to format your optional parameter, you need to craft it in a special way so you don't get an `Undefined` error in pages without the optional parameter.

Say, for example, that your optional parameter is `instructions`. You would craft it like this:

`{props.instructions && <Markdown text={props.instructions} />}`

instead of `<Markdown text={props.instructions} />`

:::

For each of the below examples, you can open the dropdown to view the partial's content.

### Properties as a plain string
Expand Down