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.

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

[docs] Improve the SvgIcon documentation #18560

Merged
merged 11 commits into from
Nov 29, 2019
Merged

[docs] Improve the SvgIcon documentation #18560

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8c34fb8
[docs] Improve the SvgIcon documentation
oliviertassinari Nov 25, 2019
09ce5a0
Matt review
oliviertassinari Nov 25, 2019
7f232e6
Update docs/src/pages/components/icons/icons.md
oliviertassinari Nov 25, 2019
844f3a5
Update docs/src/pages/components/icons/icons.md
oliviertassinari Nov 25, 2019
d9c6eab
Fix typo
oliviertassinari Nov 27, 2019
f62792d
Update docs/src/pages/components/icons/icons.md
oliviertassinari Nov 27, 2019
4b1973a
Update docs/src/pages/components/icons/icons.md
oliviertassinari Nov 27, 2019
1eb6996
Update docs/src/pages/components/icons/icons.md
oliviertassinari Nov 27, 2019
8163c77
Update docs/src/pages/components/icons/icons.md
oliviertassinari Nov 27, 2019
2df0c46
Update docs/src/pages/components/icons/icons.md
oliviertassinari Nov 27, 2019
b6f88b9
Update docs/src/pages/components/icons/icons.md
oliviertassinari Nov 27, 2019
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
2 changes: 1 addition & 1 deletion docs/src/pages/components/icons/icons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The safest is Option 1 but Option 2 can yield the best developer experience.
Make sure you follow the [minimizing bundle size guide](/guides/minimizing-bundle-size/#option-2) before using the second approach.
The configuration of a Babel plugin is encouraged.

Each icon also has a theme: Filled (default), Outlined, Rounded, Two tone and Sharp. If you want to import the icon component with a theme different than default, append the theme name to the icon name. For example `@material-ui/icons/Delete` icon with:
Each icon also has a "theme": Filled (default), Outlined, Rounded, Two tone and Sharp. If you want to import the icon component with a theme different than default, append the theme name to the icon name. For example `@material-ui/icons/Delete` icon with:
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

- Filled theme (default) is exported as `@material-ui/icons/Delete`,
- Outlined theme is exported as `@material-ui/icons/DeleteOutlined`,
Expand Down