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

[SvgIcon] Correct API docs and code style #30470

Merged
merged 1 commit into from
Jan 3, 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
8 changes: 5 additions & 3 deletions docs/src/pages/components/icons/icons.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,9 @@ If you need a custom SVG icon (not available in the [Material Icons](/components
This component extends the native `<svg>` element:

- It comes with built-in accessibility.
- SVG elements should be scaled for a 24x24px viewport so that the resulting icon can be used as is, or included as a child for other MUI components that use icons. (This can be customized with the `viewBox` attribute, to inherit `viewBox` value from original image `inheritViewBox` attribute can be used).
- SVG elements should be scaled for a 24x24px viewport so that the resulting icon can be used as is, or included as a child for other MUI components that use icons.
This can be customized with the `viewBox` attribute.
To inherit the `viewBox` value from the original image, the `inheritViewBox` attribute can be used.
- By default, the component inherits the current color. Optionally, you can apply one of the theme colors using the `color` prop.

```jsx
Expand Down Expand Up @@ -133,7 +135,7 @@ You can use the `SvgIcon` wrapper even if your icons are saved in the `.svg` for
// ---
import StarIcon from './star.svg';

<SvgIcon component={StarIcon} viewBox="0 0 600 476.6" />
<SvgIcon component={StarIcon} inheritViewBox />
```

It's also possible to use it with "url-loader" or "file-loader". This is the approach used by Create React App.
Expand All @@ -148,7 +150,7 @@ It's also possible to use it with "url-loader" or "file-loader". This is the app
// ---
import { ReactComponent as StarIcon } from './star.svg';

<SvgIcon component={StarIcon} viewBox="0 0 600 476.6" />
<SvgIcon component={StarIcon} inheritViewBox />
```

### createSvgIcon
Expand Down
2 changes: 1 addition & 1 deletion docs/translations/api-docs/svg-icon/svg-icon.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"component": "The component used for the root node. Either a string to use a HTML element or a component.",
"fontSize": "The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.",
"htmlColor": "Applies a color attribute to the SVG element.",
"inheritViewBox": "Useful when you want to reference a custom <code>component</code> and have <code>SvgIcon</code> pass that <code>component</code>&#39;s viewBox to the root node. If <code>true</code>, the root node will inherit the custom <code>component</code>&#39;s viewBox and the <code>viewBox</code> prop will be ignored.",
"inheritViewBox": "If <code>true</code>, the root node will inherit the custom <code>component</code>&#39;s viewBox and the <code>viewBox</code> prop will be ignored. Useful when you want to reference a custom <code>component</code> and have <code>SvgIcon</code> pass that <code>component</code>&#39;s viewBox to the root node.",
"shapeRendering": "The shape-rendering attribute. The behavior of the different options is described on the <a href=\"https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/shape-rendering\">MDN Web Docs</a>. If you are having issues with blurry icons you should investigate this prop.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/the-sx-prop/\">`sx` page</a> for more details.",
"titleAccess": "Provides a human-readable title for the element that contains it. <a href=\"https://www.w3.org/TR/SVG-access/#Equivalent\">https://www.w3.org/TR/SVG-access/#Equivalent</a>",
Expand Down
4 changes: 2 additions & 2 deletions packages/mui-material/src/SvgIcon/SvgIcon.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ export interface SvgIconTypeMap<P = {}, D extends React.ElementType = 'svg'> {
*/
htmlColor?: string;
/**
* Useful when you want to reference a custom `component` and have `SvgIcon` pass that
* `component`'s viewBox to the root node.
* If `true`, the root node will inherit the custom `component`'s viewBox and the `viewBox`
* prop will be ignored.
* Useful when you want to reference a custom `component` and have `SvgIcon` pass that
* `component`'s viewBox to the root node.
* @default false
*/
inheritViewBox?: boolean;
Expand Down
6 changes: 3 additions & 3 deletions packages/mui-material/src/SvgIcon/SvgIcon.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ const SvgIcon = React.forwardRef(function SvgIcon(inProps, ref) {
component = 'svg',
fontSize = 'medium',
htmlColor,
titleAccess,
inheritViewBox = false,
titleAccess,
viewBox = '0 0 24 24',
...other
} = props;
Expand Down Expand Up @@ -164,10 +164,10 @@ SvgIcon.propTypes /* remove-proptypes */ = {
*/
htmlColor: PropTypes.string,
/**
* Useful when you want to reference a custom `component` and have `SvgIcon` pass that
* `component`'s viewBox to the root node.
* If `true`, the root node will inherit the custom `component`'s viewBox and the `viewBox`
* prop will be ignored.
* Useful when you want to reference a custom `component` and have `SvgIcon` pass that
* `component`'s viewBox to the root node.
* @default false
*/
inheritViewBox: PropTypes.bool,
Expand Down
11 changes: 7 additions & 4 deletions packages/mui-material/src/SvgIcon/SvgIcon.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,21 +98,24 @@ describe('<SvgIcon />', () => {
});

describe('prop: inheritViewBox', () => {
const customSvg = (props) => (
const CustomSvg = (props) => (
<svg viewBox="-4 -4 24 24" {...props}>
{path}
</svg>
);

it('should render with the default viewBox if neither inheritViewBox nor viewBox are provided', () => {
const { container } = render(<SvgIcon component={customSvg} />);
const { container } = render(<SvgIcon component={CustomSvg} />);
expect(container.firstChild).to.have.attribute('viewBox', '0 0 24 24');
});

it('should render with given viewBox if inheritViewBox is not provided', () => {
const { container } = render(<SvgIcon component={customSvg} viewBox="0 0 30 30" />);
const { container } = render(<SvgIcon component={CustomSvg} viewBox="0 0 30 30" />);
expect(container.firstChild).to.have.attribute('viewBox', '0 0 30 30');
});

it("should use the custom component's viewBox if true", () => {
const { container } = render(<SvgIcon component={customSvg} inheritViewBox />);
const { container } = render(<SvgIcon component={CustomSvg} inheritViewBox />);
expect(container.firstChild).to.have.attribute('viewBox', '-4 -4 24 24');
});
});
Expand Down