-
Notifications
You must be signed in to change notification settings - Fork 2.9k
(docs): update Icon docs with examples #24768
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
7 changes: 7 additions & 0 deletions
7
change/@fluentui-react-components-eca314cc-3bb0-44aa-bee3-e4a10f37354c.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "patch", | ||
| "comment": "docs: update Icon docs with examples", | ||
| "packageName": "@fluentui/react-components", | ||
| "email": "[email protected]", | ||
| "dependentChangeType": "patch" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,7 +25,63 @@ You can import the sized icons in a similar way: | |
| import { AccessTime24Filled } from '@fluentui/react-icons'; | ||
| ``` | ||
|
|
||
| ### List of available props | ||
|
|
||
| Each icon also accepts `className` and `primaryFill` props for styling. | ||
| You can also use the `bundleIcon` method to bundle a `filled` and unfilled version of an icon and this will combine them into one icon. | ||
|
|
||
| | - Name - | Description | Default | | ||
| | ----------- | ---------------------------------------------------------------------------------------------------------------------- | -------------- | | ||
| | className | Used to style the icon | - | | ||
| | filled | Used to determine whether the filled or unfilled version of an icon is the default when `bundleIcon` is used `boolean` | - | | ||
| | primaryFill | Used to change the primary fill of the icon | `currentColor` | | ||
| | title | Specifies the title attribute for the svg | - | | ||
|
|
||
| ### Example | ||
|
|
||
| In this example, the `bundleIcon` method is used to combine the `regular` and `filled` versions of the `AccessTime` icons | ||
| and toggle between them on hover. | ||
|
|
||
| ```tsx | ||
| import * as React from 'react'; | ||
| import { | ||
| AccessTimeFilled, | ||
| AccessTimeRegular, | ||
| bundleIcon, | ||
| iconFilledClassName, | ||
| iconRegularClassName, | ||
| } from '@fluentui/react-icons'; | ||
| import { makeStyles } from '@fluentui/react-components'; | ||
|
|
||
| const iconStyleProps: FluentIconsProps = { | ||
| primaryFill: 'purple', | ||
| className: 'iconClass', | ||
| }; | ||
|
|
||
| const useIconStyles = makeStyles({ | ||
| icon: { | ||
| ':hover': { | ||
| [`& .${iconFilledClassName}`]: { | ||
| display: 'none', | ||
| }, | ||
| [`& .${iconRegularClassName}`]: { | ||
| display: 'inline', | ||
| }, | ||
| }, | ||
| }, | ||
| }); | ||
|
|
||
| const AccessTime = bundleIcon(AccessTimeFilled, AccessTimeRegular); | ||
| function App() { | ||
| const styles = useIconStyles(); | ||
|
|
||
| return ( | ||
| <div className={styles.icon}> | ||
| <AccessTime aria-label="An AccessTime icon" {...iconStyleProps} /> | ||
| </div> | ||
| ) | ||
| ); | ||
| ``` | ||
|
|
||
| ### Fluent icons as fonts | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you also add a code sample how to use icons as fonts ? |
||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.