mirror of
https://github.com/vector-im/element-web.git
synced 2024-11-16 21:24:59 +08:00
e6ea58e84d
* extend svg module Signed-off-by: Kerry Archibald <kerrya@element.io> * POC in QuickSettingsButton Signed-off-by: Kerry Archibald <kerrya@element.io> * stylelint Signed-off-by: Kerry Archibald <kerrya@element.io> * update copyright Signed-off-by: Kerry Archibald <kerrya@element.io> * remove aria-hidden, quick docs Signed-off-by: Kerry Archibald <kerrya@element.io>
44 lines
1.1 KiB
Markdown
44 lines
1.1 KiB
Markdown
# Icons
|
|
|
|
Icons are loaded using [@svgr/webpack](https://www.npmjs.com/package/@svgr/webpack). This is configured in [element-web](https://github.com/vector-im/element-web/blob/develop/webpack.config.js#L458)
|
|
|
|
Each .svg exports a `ReactComponent` at the named export `Icon`.
|
|
Icons have `role="presentation"` and `aria-hidden` automatically applied. These can be overriden by passing props to the icon component.
|
|
|
|
eg
|
|
```
|
|
import { Icon as FavoriteIcon } from 'res/img/element-icons/favorite.svg';
|
|
|
|
const MyComponent = () => {
|
|
return <>
|
|
<FavoriteIcon>
|
|
<FavoriteIcon className="mx_MyComponent-icon" role="img" aria-hidden="false">
|
|
</>;
|
|
}
|
|
```
|
|
|
|
## Styling
|
|
|
|
Icon components are svg elements and can be styled as usual.
|
|
|
|
```
|
|
// _MyComponents.scss
|
|
.mx_MyComponent-icon {
|
|
height: 20px;
|
|
width: 20px;
|
|
|
|
* {
|
|
fill: $accent;
|
|
}
|
|
}
|
|
|
|
// MyComponent.tsx
|
|
import { Icon as FavoriteIcon } from 'res/img/element-icons/favorite.svg';
|
|
|
|
const MyComponent = () => {
|
|
return <>
|
|
<FavoriteIcon>
|
|
<FavoriteIcon className="mx_MyComponent-icon" role="img" aria-hidden="false">
|
|
</>;
|
|
}
|
|
``` |