Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* chore: simplify icon * docs: simplify buttons * docs: site blog part * docs: fix trans * docs: cssinjs Co-authored-by: MadCcc <1075746765@qq.com>
- Loading branch information
Showing
9 changed files
with
272 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| import * as React from 'react'; | ||
| import { Button, Tooltip } from 'antd'; | ||
| import useSharedStyle from './style'; | ||
| import useSiteToken from '../../../hooks/useSiteToken'; | ||
| import { css } from '@emotion/react'; | ||
|
|
||
| export interface LangBtnProps { | ||
| label1: React.ReactNode; | ||
| label2: React.ReactNode; | ||
| tooltip1?: React.ReactNode; | ||
| tooltip2?: React.ReactNode; | ||
| value: 1 | 2; | ||
| pure?: boolean; | ||
| onClick?: React.MouseEventHandler; | ||
| } | ||
|
|
||
| const useStyle = () => { | ||
| const { token } = useSiteToken(); | ||
| const { controlHeightSM } = token; | ||
|
|
||
| return { | ||
| btn: css` | ||
| padding: 0 !important; | ||
| width: ${controlHeightSM}px; | ||
| height: ${controlHeightSM}px; | ||
| display: inline-flex; | ||
| align-items: center; | ||
| justify-content: center; | ||
| img { | ||
| width: 1em; | ||
| height: 1em; | ||
| } | ||
| `, | ||
| }; | ||
| }; | ||
|
|
||
| export default function LangBtn({ | ||
| label1, | ||
| label2, | ||
| tooltip1, | ||
| tooltip2, | ||
| value, | ||
| pure, | ||
| onClick, | ||
| }: LangBtnProps) { | ||
| const { token } = useSiteToken(); | ||
| const style = useStyle(); | ||
| const sharedStyle = useSharedStyle(); | ||
|
|
||
| let label1Style: React.CSSProperties; | ||
| let label2Style: React.CSSProperties; | ||
|
|
||
| const iconStyle: React.CSSProperties = { | ||
| position: 'absolute', | ||
| fontSize: '1em', | ||
| lineHeight: 1, | ||
| border: `1px solid ${token.colorText}`, | ||
| color: token.colorText, | ||
| }; | ||
|
|
||
| const fontStyle: React.CSSProperties = { | ||
| left: '-5%', | ||
| top: 0, | ||
| zIndex: 1, | ||
| background: token.colorText, | ||
| color: token.colorTextLightSolid, | ||
| transformOrigin: '0 0', | ||
| transform: `scale(0.7)`, | ||
| }; | ||
| const backStyle: React.CSSProperties = { | ||
| right: '-5%', | ||
| bottom: 0, | ||
| zIndex: 0, | ||
| transformOrigin: '100% 100%', | ||
| transform: `scale(0.5)`, | ||
| }; | ||
|
|
||
| if (value === 1) { | ||
| label1Style = fontStyle; | ||
| label2Style = backStyle; | ||
| } else { | ||
| label1Style = backStyle; | ||
| label2Style = fontStyle; | ||
| } | ||
|
|
||
| let node = ( | ||
| <Button | ||
| size="small" | ||
| onClick={onClick} | ||
| css={[sharedStyle.headerButton, style.btn]} | ||
| key="lang-button" | ||
| > | ||
| {pure ? ( | ||
| value === 1 ? ( | ||
| label1 | ||
| ) : ( | ||
| label2 | ||
| ) | ||
| ) : ( | ||
| <div style={{ position: 'relative', width: '1em', height: '1em' }}> | ||
| <span | ||
| style={{ | ||
| ...iconStyle, | ||
| ...label1Style, | ||
| }} | ||
| > | ||
| {label1} | ||
| </span> | ||
| <span | ||
| style={{ | ||
| ...iconStyle, | ||
| ...label2Style, | ||
| }} | ||
| > | ||
| {label2} | ||
| </span> | ||
| </div> | ||
| )} | ||
| </Button> | ||
| ); | ||
|
|
||
| if (tooltip1 || tooltip2) { | ||
| node = <Tooltip title={value === 1 ? tooltip1 : tooltip2}>{node}</Tooltip>; | ||
| } | ||
|
|
||
| return node; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| import { css } from '@emotion/react'; | ||
| import useSiteToken from '../../../hooks/useSiteToken'; | ||
|
|
||
| const useSharedStyle = () => { | ||
| const { token } = useSiteToken(); | ||
|
|
||
| return { | ||
| headerButton: css` | ||
| color: ${token.colorText}; | ||
| border-color: ${token.colorBorder}; | ||
| `, | ||
| }; | ||
| }; | ||
|
|
||
| export default useSharedStyle; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| order: 0 | ||
| title: Component-level CSS-in-JS | ||
| --- | ||
|
|
||
| On November 18, 2022, we released Ant Design 5.0. At the same time, Ant Design's unique CSS-in-JS solution was brought into everyone's view. Through this solution, Ant Design achieves higher performance than other CSS-in-JS libraries, but at the cost of sacrificing its flexibility for free use in applications. So we call it a "component-level" CSS-in-JS solution. <a name="W668Z"></a> | ||
|
|
||
| ## Dilemma of CSS-in-JS | ||
|
|
||
| In CSS-in-JS, hash is used to confirm whether a style has been inserted. The way to calculate the hash is usually to convert a complete css into a hash value. For example, in emotion, we can see such a style tag by checking the elements on the page. The hash value corresponding to such a style tag is unique:<br /><br />In this way, you can find a problem that CSS-in-JS has been criticized for a long time. What we write when coding is not the final css. So every time we need to serialize to get the css and calculate the hash again. If your page or component has a very complex or a large amount of CSS-in-JS code, and even the style will follow the component's props change, then this performance issue becomes non-negligible.<br />To solve this problem, each CSS-in-JS library will have its own way to deal with it. Let’s take a look at Ant Design’s solution. <a name="Wd3XQ"></a> | ||
|
|
||
| ## Hash | ||
|
|
||
| In fact, it is not difficult for us to find that the problem lies in the process of serializing css. How about reducing the times of serializing css by caching? For application-level CSS-in-JS, it is difficult for us to find a suitable key for cache. But if it is a component library, the final style is relatively stable. <br />According to the style structure we determined from v4 and previous versions, the style of each component will not change under the same theme variable and the same version. Conversely, the style may change only if the theme variable is modified, or the version of antd is changed. <br />From this we get a very simple way to calculate the hash:<br /><br />We will apply the **same** **hash** to all antd components. In this way, when using the antd component, we only perform hash calculations on the current version and theme variables. Version can be obtained directly from `package.json`, and theme variables can be obtained directly from context. So we don't need to serialize css again and again to get a stable hash, and the performance is improved finally. <a name="GxLK1"></a> | ||
|
|
||
| ## Cache for Components | ||
|
|
||
| In the above way, we have taken the first step of "component level" CSS-in-JS, but this is not enough. Since it is "component level", we can also optimize it again with components.<br />In Ant Design, the style of a component is usually complete. That is to say, no matter what variant the component has, its style exist in the whole component style. In this way, we can draw a conclusion again: the props of antd components will not affect the component style. <br />This is very important. In the application-level CSS-in-JS solution, since props may affect the component style, it is inevitable that the component style will be regenerated during the rendering phase. No matter how to optimize this point, it cannot be ignored. Now that we have adopted a "component-level" solution, this problem can be easily solved: do style caching for components.<br /><br />In the case of the same hash, no matter how many times the same component is used and rendered, the style will only be generated once at the first mount, and will hit the cache for the rest of the time. This is the second insurance for "component level" CSS-in-JS solutions. <a name="DUbKx"></a> | ||
|
|
||
| ## Benchmark | ||
|
|
||
| At the release of Ant Design 5.0, we simply made a benchmark, and here are some supplementary instructions:<br /><br />The benchmark is based on generating a very long unchanging style to test the performance of basic usage of the three libraries. It can be seen that under the "component level" usage scenario of Ant Design, @ant-design/cssinjs has a performance advantage whether it is the first rendering or the second rendering. Since styled has certain optimizations when dealing with stable styles, the performance of secondary rendering in this benchmark is better, but it will still be affected by recalculation like emotion when props participate in style calculation. <a name="JOmkZ"></a> | ||
|
|
||
| ## Limitation | ||
|
|
||
| In the above comparison, it cannot be said that antd is definitely better than styled and emotion, but in the component-level usage scenarios, we have made corresponding optimizations to obtain performance advantages. Conversely, due to the limitation of "component level", antd's CSS-in-JS solution is not suitable for construction applications.<br />Due to the special hash calculation method and component cache, when applying antd's CSS-in-JS solution, developers must provide stable hash and unique component names by themselves. For applications, automatic hash capabilities such as css modules are more needed. At the same time, caching a large number of components in the application also requires additional management costs. Once an error occurs, it is difficult to troubleshoot. Therefore, we recommend using the "component-level" CSS-in-JS solution in component libraries. |
Oops, something went wrong.