Skip to content

Document undocumented component props and iconType values #4632

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

Closed
mintlify-development wants to merge 1 commit into from
Closed

Document undocumented component props and iconType values #4632

Show file tree
Hide file tree
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
4 changes: 4 additions & 0 deletions components/cards.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,7 @@ Use the [Columns component](/components/columns) to organize multiple cards side
<ResponseField name="arrow" type="boolean">
Show or hide the link arrow icon.
</ResponseField>

<ResponseField name="disabled" type="boolean">
Disable the card link. When `true`, the card is not clickable and the CTA button appears dimmed.
</ResponseField>
8 changes: 8 additions & 0 deletions components/examples.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
- Code samples that users reference while following instructions
- Before and after examples in tutorials

On mobile devices, `<RequestExample>` and `<ResponseExample>` components display as regular code blocks and can be scrolled past.

Check warning on line 16 in components/examples.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/examples.mdx#L16 

In general, use active voice instead of passive voice ('be scrolled').

<RequestExample>

Expand Down Expand Up @@ -62,3 +62,11 @@

</ResponseExample>
````

## Properties

Both `<RequestExample>` and `<ResponseExample>` accept the following property:

<ResponseField name="dropdown" type="boolean">
Display a language dropdown instead of tabs when multiple code blocks are provided.

Check warning on line 71 in components/examples.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/examples.mdx#L71 

In general, use active voice instead of passive voice ('are provided').
</ResponseField>
6 changes: 5 additions & 1 deletion components/expandables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Expandables"

Check warning on line 2 in components/expandables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/expandables.mdx#L2 

Use 'expandables' instead of 'Expandables'.
description: "Toggle expandable sections to show and hide nested object properties in API documentation and response fields."
keywords: ["expandables", "nested properties", "expandable fields", "toggle content"]
---
Expand Down Expand Up @@ -41,5 +41,9 @@
</ResponseField>

<ResponseField name="defaultOpen" type="boolean" default="false">
Set to `true` for the expandable to open when the page loads
Set to `true` for the expandable to open when the page loads.
</ResponseField>

<ResponseField name="lazy" type="boolean">
When `true`, children are not rendered until the expandable is first opened. Useful for improving page load performance when the expandable contains heavy content.
</ResponseField>
20 changes: 20 additions & 0 deletions components/fields.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Parameter field

The `<ParamField>` component is used to define parameters for your APIs or SDKs. Adding a `ParamField` automatically adds an [API Playground](/api-playground/overview).

Check warning on line 11 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L11 

In general, use active voice instead of passive voice ('is used').

<ParamField path="param" type="string" required>
An example of a parameter field
Expand All @@ -32,16 +32,16 @@

Supports `number`, `string`, `boolean`, `object`.

Arrays can be defined using the `[]` suffix. For example `string[]`.

Check warning on line 35 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L35 

In general, use active voice instead of passive voice ('be defined').

</ParamField>

<ParamField body="required" type="boolean">
Indicate whether the parameter is required.

Check warning on line 40 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L40 

In general, use active voice instead of passive voice ('is required').
</ParamField>

<ParamField body="deprecated" type="boolean">
Indicate whether the parameter is deprecated.

Check warning on line 44 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L44 

In general, use active voice instead of passive voice ('is deprecated').
</ParamField>

<ParamField body="default" type="any">
Expand All @@ -52,6 +52,18 @@
Placeholder text for the input in the playground.
</ParamField>

<ParamField body="enum" type="string[]">
A list of allowed values for the parameter.
</ParamField>

<ParamField body="hidden" type="boolean">
Hide the field from the documentation. The field is still functional but not visible.
</ParamField>

<ParamField body="id" type="string">
Custom anchor ID for linking directly to this field.
</ParamField>

<ParamField body="children" type="string">
Description of the parameter (Markdown-enabled).
</ParamField>
Expand Down Expand Up @@ -85,17 +97,25 @@
</ResponseField>

<ResponseField name="required" type="boolean">
Indicate whether the response is required.

Check warning on line 100 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L100 

In general, use active voice instead of passive voice ('is required').
</ResponseField>

<ResponseField name="deprecated" type="boolean">
Whether a field is deprecated.

Check warning on line 104 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L104 

In general, use active voice instead of passive voice ('is deprecated').
</ResponseField>

<ResponseField name="hidden" type="boolean">
Hide the field from the documentation. The field is still functional but not visible.
</ResponseField>

<ResponseField name="id" type="string">
Custom anchor ID for linking directly to this field.
</ResponseField>

<ResponseField name="pre" type="string[]">
Labels that are shown before the name of the field.

Check warning on line 116 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L116 

In general, use active voice instead of passive voice ('are shown').
</ResponseField>

<ResponseField name="post" type="string[]">
Labels that are shown after the name of the field.

Check warning on line 120 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L120 

In general, use active voice instead of passive voice ('are shown').
</ResponseField>
12 changes: 10 additions & 2 deletions components/responses.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,23 @@
</ResponseField>

<ResponseField name="deprecated" type="boolean">
Whether a field is deprecated or not.

Check warning on line 38 in components/responses.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/responses.mdx#L38 

In general, use active voice instead of passive voice ('is deprecated').
</ResponseField>

<ResponseField name="hidden" type="boolean">
Hide the field from the documentation. The field is still functional but not visible.
</ResponseField>

<ResponseField name="id" type="string">
Custom anchor ID for linking directly to this field.
</ResponseField>

<ResponseField name="pre" type="string[]">
Labels that are shown before the name of the field
Labels that are shown before the name of the field.

Check warning on line 50 in components/responses.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/responses.mdx#L50 

In general, use active voice instead of passive voice ('are shown').
</ResponseField>

<ResponseField name="post" type="string[]">
Labels that are shown after the name of the field
Labels that are shown after the name of the field.

Check warning on line 54 in components/responses.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/responses.mdx#L54 

In general, use active voice instead of passive voice ('are shown').
</ResponseField>

<RequestExample>
Expand Down
2 changes: 1 addition & 1 deletion snippets/icons-optional.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@
<ResponseField name="iconType" type="string">
The [Font Awesome](https://fontawesome.com/icons) icon style. Only used with Font Awesome icons.

Options: `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands`.
Options: `regular`, `solid`, `light`, `thin`, `sharp-solid`, `sharp-regular`, `sharp-light`, `sharp-thin`, `sharp-duotone-solid`, `duotone`, `brands`.
</ResponseField>
2 changes: 1 addition & 1 deletion snippets/icons-required.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@
<ResponseField name="iconType" type="string">
The [Font Awesome](https://fontawesome.com/icons) icon style. Only used with Font Awesome icons.

Options: `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands`.
Options: `regular`, `solid`, `light`, `thin`, `sharp-solid`, `sharp-regular`, `sharp-light`, `sharp-thin`, `sharp-duotone-solid`, `duotone`, `brands`.
</ResponseField>
Loading