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

feat: move icons to use fontSize #257

Closed
wants to merge 2 commits into from
Closed

feat: move icons to use fontSize #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd63966
feat: move icons to use `fontSize`
inomdzhon Aug 10, 2022
51a5d0e
fix(review): rename variables; fix comments
inomdzhon Aug 10, 2022
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
21 changes: 16 additions & 5 deletions packages/icons-scripts/scripts/reactify.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,17 @@ const Compiler = require('svg-baker');

const compiler = new Compiler();

function pxToEm(pxSize, baseSize) {
return `${Number((pxSize / baseSize).toFixed(4))}em`;
}

const reactify = (symbol, componentName) => {
const width = symbol.viewBox.split(' ')[2];
const height = symbol.viewBox.split(' ')[3];
const viewBoxWidth = Number(symbol.viewBox.split(' ')[2]);
const viewBoxHeight = Number(symbol.viewBox.split(' ')[3]);

const fontSize = Math.max(viewBoxWidth, viewBoxHeight);
const fontSizeWidth = pxToEm(viewBoxWidth, fontSize);
const fontSizeHeight = pxToEm(viewBoxHeight, fontSize);

return `import { HTMLAttributes, RefCallback, RefObject } from 'react';
import { makeIcon } from '../SvgIcon';
Expand All @@ -20,9 +28,12 @@ export default makeIcon<${componentName}Props>(
'${componentName}',
'${symbol.id}',
'${symbol.viewBox}',
'${symbol.render()}',
${width},
${height}
${viewBoxWidth},
${viewBoxHeight},
${fontSize},
'${fontSizeWidth}',
'${fontSizeHeight}',
'${symbol.render()}'
);
`;
};
Expand Down
74 changes: 59 additions & 15 deletions packages/icons-scripts/src/SvgIcon.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,32 @@ import BrowserSymbol from 'svg-baker-runtime/browser-symbol';
import { IconSettingsInterface, IconSettingsContext } from './IconSettings';
import { addSpriteSymbol, useIsomorphicLayoutEffect } from './sprite';

/** @public */
export interface SvgIconProps extends React.HTMLAttributes<HTMLDivElement> {
/**
* Для пропорционального изменения размера иконки относительно размера шрифта.
*
* > 📝 Чтобы размер наследовался от базового размера шрифта, передайте `"inherit"` или `"1em"`.
*
* @default берётся `Math.max(width, height)` иконки (см. `viewBox`)
*/
fontSize?: string | number;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

number | 'inherit'?

Copy link
Contributor Author

@inomdzhon inomdzhon Aug 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Хм, думал об этом, но font-size принимает гораздо больше значений

image

или думаешь стоит ограничить?

UPD
а, такая типизация не будет покрывать передачу "<number>em", "<number>%" и т.п.

fill?: string;
width?: number;
height?: number;
viewBox?: string;
fill?: string;
getRootRef?: React.RefCallback<HTMLDivElement> | React.RefObject<HTMLDivElement>;
Component?: React.ElementType,
}

/** @private */
interface SvgIconInternalProps extends SvgIconProps {
viewBoxWidth: number;
viewBoxHeight: number;
fontSizeWidth: string;
fontSizeHeight: string;
}

const svgStyle = { display: 'block' };

function iconClass(fragments: string[], { classPrefix, globalClasses }: IconSettingsInterface) {
Expand All @@ -28,9 +45,20 @@ function iconClass(fragments: string[], { classPrefix, globalClasses }: IconSett
return res;
}

const SvgIcon: React.FC<SvgIconProps> = ({
width,
height,
const SvgIcon: React.FC<SvgIconInternalProps> = ({
/**
* Внутренние параметры (скрыты от пользователя).
*/
viewBoxWidth,
viewBoxHeight,
fontSizeWidth,
fontSizeHeight,

/**
* Пользовательские параметры.
*/
width: widthProp,
height: heightProp,
viewBox,
id,
className = '',
Expand All @@ -39,22 +67,28 @@ const SvgIcon: React.FC<SvgIconProps> = ({
getRootRef,
Component = 'div',
role,
fontSize,
"aria-label": ariaLabel,
"aria-hidden": ariaHidden,
...restProps
}) => {
const size = Math.max(width, height);

const iconSettings = React.useContext(IconSettingsContext);
const ownClass = iconClass(['Icon', `Icon--${size}`, `Icon--w-${width}`, `Icon--h-${height}`, `Icon--${id}`], iconSettings);

const classNameWidth = widthProp || viewBoxWidth;
const classNameHeight = heightProp || viewBoxHeight;
const classNameSize = Math.max(classNameWidth, classNameHeight);
const ownClass = iconClass(['Icon', `Icon--${classNameSize}`, `Icon--w-${classNameWidth}`, `Icon--h-${classNameHeight}`, `Icon--${id}`], iconSettings);

const width = widthProp || fontSizeWidth;
const height = heightProp || fontSizeHeight;

return (
<Component
role="presentation"
{...restProps}
ref={getRootRef}
className={`${ownClass} ${className}`}
style={{ ...style, width, height }}
style={{ ...style, width, height, fontSize }}
>
<svg
viewBox={viewBox}
Expand All @@ -75,9 +109,12 @@ export function makeIcon<Props extends SvgIconProps = SvgIconProps>(
componentName: string,
id: string,
viewBox: string,
viewBoxWidth: number,
viewBoxHeight: number,
fontSize: number,
fontSizeWidth: string,
fontSizeHeight: string,
content: string,
width: number,
height: number
): React.FC<Props> {
let isMounted = false;
function mountIcon() {
Expand All @@ -87,16 +124,23 @@ export function makeIcon<Props extends SvgIconProps = SvgIconProps>(
}
}

const Icon: React.FC<Props> = (props) => {
const Icon: React.FC<Props> = ({
viewBox: viewBoxProp = viewBox,
fontSize: fontSizeProp = fontSize,
...restProps
}) => {
useIsomorphicLayoutEffect(mountIcon, []);

return (
<SvgIcon
{...props}
viewBox={viewBox}
{...restProps}
viewBox={viewBoxProp}
fontSize={fontSizeProp}
id={id}
width={!isNaN(props.width) ? +props.width : width}
height={!isNaN(props.height) ? +props.height : height}
viewBoxWidth={viewBoxWidth}
viewBoxHeight={viewBoxHeight}
fontSizeWidth={fontSizeWidth}
fontSizeHeight={fontSizeHeight}
/>
)
};
Expand Down
39 changes: 35 additions & 4 deletions src/docs/docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,16 @@ const example =

<Icon24Cancel />`;

const sizeExample = `<Icon24LogoVk width={20} height={20} />`;
const sizeExampleFontSizeInherit =
`<p style={{ fontSize: 16 }>
<a href="https://google.com" target="_blank">
https://google.com <Icon24ExternalLinkOutline fontSize="inherit" />
</a>
</p>`;

const sizeExampleFontSizeFix = `<Icon24LogoVk fontSize={20} />`;

const sizeExampleFixSize = `<Icon16MoreVertical width={12} height={24} />`;

class Docs extends React.PureComponent {
constructor (props) {
Expand Down Expand Up @@ -87,10 +96,32 @@ class Docs extends React.PureComponent {
<pre>{example}</pre>
<h2>Кастомные размеры</h2>
<p>
Иногда может потребоваться установить для иконки другой размер.
Для этого можно передать свойства <code>width</code> и <code>height</code>, ширина и высота в пикселях. <b>Они должны быть числовыми значениями.</b>
Иногда может потребоваться установить для иконки другой размер. Для этого используйте параметр
{" "}<code>fontSize</code>, который принимает все валидные для него значения.
</p>
<p>
Например, иконка вставлена в блок с текстом и, для лучшего выравнивания, нам нужно, чтобы она имела размер,
равный высоте текста. Мы добьёмся этого передав <code>fontSize="inherit"</code> или
{" "}<code>fontSize="1em"</code>:
</p>
<pre>{sizeExampleFontSizeInherit}</pre>
<p>
А вот пример с фиксированным размером иконки:
</p>
<pre>{sizeExampleFontSizeFix}</pre>
<br />
<p>
Также можно изменить размер через параметры <code>width</code> и <code>height</code>. Нюансы:

<ol>
<li>значения должны быть <b>числовыми</b>;</li>
<li>следует соблюсти <b>соотношение сторон</b> (см. <code>viewBox</code> конкретной иконки);</li>
<li>параметр <code>fontSize</code> больше не будет играть роли</li>
</ol>

Пример:
</p>
<pre>{sizeExample}</pre>
<pre>{sizeExampleFixSize}</pre>
<h2>Стилизация</h2>
<div className="color">
<p>
Expand Down