Skip to content

Commit

Permalink
feat(docs): add docs for navbar icon (#4732)
Browse files Browse the repository at this point in the history
  • Loading branch information
chdeskur authored Sep 24, 2024
1 parent 56143b3 commit 3d27595
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions fern/pages/docs/getting-started/global-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,16 @@ navbar-links:
Whether the button is rounded or square.
</ParamField>

<ParamField path="icon" type="string" required={false}>
The [Font Awesome icon](https://fontawesome.com/icons) to be used in the button. This icon will appear to the **left** of the text content.
</ParamField>

<ParamField path="rightIcon" type="string" required={false}>
The [Font Awesome icon](https://fontawesome.com/icons) to be used in the button. This icon will appear to the **right** of the text content.

By default, the `rightIcon` for a `filled` button is set to `arrow-right`.
</ParamField>

## Background image configuration

```yaml docs.yml
Expand Down

0 comments on commit 3d27595

Please sign in to comment.