Skip to content
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

(docs): update Icon docs with examples #24768

Merged
merged 5 commits into from
Oct 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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"
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
tomi-msft marked this conversation as resolved.
Show resolved Hide resolved
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
Copy link
Member

Choose a reason for hiding this comment

The 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 ?


Expand Down