@cloud-ru/ds-ai-shimmer 1.0.1 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/README.md +22 -5
- package/dist/cjs/AiShimmer.d.ts +1 -1
- package/dist/cjs/AiShimmer.js +40 -39
- package/dist/cjs/constants.d.ts +47 -26
- package/dist/cjs/constants.js +24 -39
- package/dist/cjs/style.css +248 -190
- package/dist/cjs/styles.module.css +248 -190
- package/dist/cjs/types.d.ts +15 -10
- package/dist/esm/AiShimmer.d.ts +1 -1
- package/dist/esm/AiShimmer.js +43 -42
- package/dist/esm/constants.d.ts +47 -26
- package/dist/esm/constants.js +22 -37
- package/dist/esm/style.css +248 -190
- package/dist/esm/styles.module.css +248 -190
- package/dist/esm/types.d.ts +15 -10
- package/dist/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/tsconfig.esm.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/src/AiShimmer.tsx +78 -57
- package/src/constants.ts +26 -44
- package/src/styles.module.scss +139 -90
- package/src/types.ts +15 -11
package/dist/cjs/types.d.ts
CHANGED
|
@@ -1,12 +1,8 @@
|
|
|
1
1
|
import { WithSupportProps } from '@cloud-ru/ds-utils';
|
|
2
|
+
import { ReactNode } from 'react';
|
|
2
3
|
export type AiShimmerVariant = 'display' | 'headline' | 'title' | 'label' | 'body';
|
|
3
4
|
export type AiShimmerSize = 's' | 'm' | 'l';
|
|
4
5
|
export type AiShimmerWeight = 'regular' | 'thin' | 'mono';
|
|
5
|
-
export type AiShimmerFontMetrics = {
|
|
6
|
-
fontSize: number;
|
|
7
|
-
lineHeight: number;
|
|
8
|
-
fontWeight: string;
|
|
9
|
-
};
|
|
10
6
|
export type AiShimmerProps = WithSupportProps<{
|
|
11
7
|
/** Текст, по которому рендерится shimmer. Поддерживает переносы строк через `\n`. */
|
|
12
8
|
text: string;
|
|
@@ -19,16 +15,25 @@ export type AiShimmerProps = WithSupportProps<{
|
|
|
19
15
|
size?: AiShimmerSize;
|
|
20
16
|
/** Начертание шрифта, как в `@cloud-ru/ds-typography`. Задаёт `data-weight`. */
|
|
21
17
|
weight?: AiShimmerWeight;
|
|
18
|
+
/**
|
|
19
|
+
* Ведущая иконка узлом — любой компонент, рендерящий `<svg>`: иконка из `@cloud-ru/ds-icons`,
|
|
20
|
+
* `AiIconGiga`, `Sun` из `@cloud-ru/ds-loader`. Узел становится маской и заливается той же волной,
|
|
21
|
+
* что текст; его собственные цвета не важны, анимация внутри иконки сохраняется. Размер
|
|
22
|
+
* узла должен совпадать с `iconSize`. Имеет приоритет над `iconMask`.
|
|
23
|
+
*/
|
|
24
|
+
icon?: ReactNode;
|
|
22
25
|
/**
|
|
23
26
|
* Силуэт ведущей иконки как CSS `mask-image` (обычно `url("data:image/svg+xml,…")`).
|
|
24
|
-
*
|
|
25
|
-
* что и текст: блеск проходит сплошной полосой «иконка → конец строки», как будто
|
|
26
|
-
* иконка — часть текста. Иконка не несёт собственного цвета, она наследует
|
|
27
|
-
* shimmer-покрытие (приглушённая база + блик).
|
|
27
|
+
* Заливается той же волной, что текст. Используется, когда `icon` не передан.
|
|
28
28
|
*/
|
|
29
29
|
iconMask?: string;
|
|
30
|
-
/** Размер ведущей иконки в px (квадрат). Действует
|
|
30
|
+
/** Размер ведущей иконки в px (квадрат). Действует с `icon` или `iconMask`. По умолчанию `16`. */
|
|
31
31
|
iconSize?: number;
|
|
32
|
+
/**
|
|
33
|
+
* Хвостовой слот справа от текста — например счётчик или длительность. Волна идёт
|
|
34
|
+
* по нему той же полосой; база слота на тон светлее текста. Свой цвет слоту не задавать.
|
|
35
|
+
*/
|
|
36
|
+
slotAfter?: ReactNode;
|
|
32
37
|
/** Дополнительный класс корневого контейнера. */
|
|
33
38
|
className?: string;
|
|
34
39
|
}>;
|
package/dist/esm/AiShimmer.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import { AiShimmerProps } from './types.js';
|
|
2
|
-
export declare function AiShimmer({ text, variant, size, weight, iconMask, iconSize, className, 'data-test-id': dataTestId, ...rest }: AiShimmerProps): import("react/jsx-runtime").JSX.Element;
|
|
2
|
+
export declare function AiShimmer({ text, variant, size, weight, icon, iconMask, iconSize, slotAfter, className, 'data-test-id': dataTestId, ...rest }: AiShimmerProps): import("react/jsx-runtime").JSX.Element;
|
package/dist/esm/AiShimmer.js
CHANGED
|
@@ -1,51 +1,49 @@
|
|
|
1
1
|
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
-
import { extractSupportProps
|
|
2
|
+
import { extractSupportProps } from '@cloud-ru/ds-utils';
|
|
3
3
|
import cn from 'classnames';
|
|
4
|
-
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
|
|
5
|
-
import { DEFAULT_ICON_SIZE, DEFAULT_ROOT_WIDTH, DEFAULT_SIZE, DEFAULT_VARIANT, DEFAULT_WEIGHT,
|
|
4
|
+
import { useCallback, useEffect, useId, useMemo, useRef, useState } from 'react';
|
|
5
|
+
import { DEFAULT_ICON_SIZE, DEFAULT_ROOT_WIDTH, DEFAULT_SIZE, DEFAULT_VARIANT, DEFAULT_WEIGHT, TEST_IDS, WAVE_GRADIENT, WAVE_STOPS, waveStopColor, } from './constants.js';
|
|
6
6
|
import styles from './styles.module.css';
|
|
7
|
-
export function AiShimmer({ text, variant = DEFAULT_VARIANT, size = DEFAULT_SIZE, weight = DEFAULT_WEIGHT, iconMask, iconSize = DEFAULT_ICON_SIZE, className, 'data-test-id': dataTestId = TEST_IDS.root, ...rest }) {
|
|
7
|
+
export function AiShimmer({ text, variant = DEFAULT_VARIANT, size = DEFAULT_SIZE, weight = DEFAULT_WEIGHT, icon, iconMask, iconSize = DEFAULT_ICON_SIZE, slotAfter, className, 'data-test-id': dataTestId = TEST_IDS.root, ...rest }) {
|
|
8
8
|
const rootRef = useRef(null);
|
|
9
9
|
const textRef = useRef(null);
|
|
10
|
-
const
|
|
11
|
-
const [contentHeight, setContentHeight] = useState(fallbackHeight);
|
|
10
|
+
const slotRef = useRef(null);
|
|
12
11
|
const [lineWidth, setLineWidth] = useState(DEFAULT_ROOT_WIDTH);
|
|
13
|
-
const
|
|
12
|
+
const [slotOffset, setSlotOffset] = useState(0);
|
|
13
|
+
const gradientId = useId();
|
|
14
|
+
const maskId = useId();
|
|
15
|
+
const hasIconNode = icon != null && icon !== false;
|
|
16
|
+
const hasIcon = hasIconNode || Boolean(iconMask);
|
|
17
|
+
const hasSlotAfter = slotAfter != null && slotAfter !== false;
|
|
18
|
+
// Волна задана в пикселях строки, поэтому ширину и отступ слота нужно замерить.
|
|
14
19
|
const measureLayout = useCallback(() => {
|
|
15
|
-
const textNode = textRef.current;
|
|
16
|
-
if (textNode) {
|
|
17
|
-
const measuredContentHeight = Math.ceil(textNode.getBoundingClientRect().height);
|
|
18
|
-
setContentHeight(prev => (Math.abs(prev - measuredContentHeight) > 0.5 ? measuredContentHeight : prev));
|
|
19
|
-
}
|
|
20
20
|
const rootNode = rootRef.current;
|
|
21
|
-
if (rootNode) {
|
|
22
|
-
|
|
23
|
-
|
|
21
|
+
if (!rootNode) {
|
|
22
|
+
return;
|
|
23
|
+
}
|
|
24
|
+
const rootRect = rootNode.getBoundingClientRect();
|
|
25
|
+
const measuredWidth = Math.ceil(rootRect.width);
|
|
26
|
+
setLineWidth(prev => (measuredWidth > 0 && Math.abs(prev - measuredWidth) > 0.5 ? measuredWidth : prev));
|
|
27
|
+
const slotNode = slotRef.current;
|
|
28
|
+
if (slotNode) {
|
|
29
|
+
const measuredOffset = slotNode.getBoundingClientRect().left - rootRect.left;
|
|
30
|
+
setSlotOffset(prev => (Math.abs(prev - measuredOffset) > 0.5 ? measuredOffset : prev));
|
|
24
31
|
}
|
|
25
32
|
}, []);
|
|
26
|
-
useLayoutEffect(() => {
|
|
27
|
-
setContentHeight(fallbackHeight);
|
|
28
|
-
measureLayout();
|
|
29
|
-
const frameId = requestAnimationFrame(() => {
|
|
30
|
-
measureLayout();
|
|
31
|
-
});
|
|
32
|
-
return () => cancelAnimationFrame(frameId);
|
|
33
|
-
}, [fallbackHeight, measureLayout, size, text, variant, weight]);
|
|
34
33
|
useEffect(() => {
|
|
35
|
-
|
|
36
|
-
const
|
|
37
|
-
if (typeof ResizeObserver === 'undefined') {
|
|
34
|
+
measureLayout();
|
|
35
|
+
const rootNode = rootRef.current;
|
|
36
|
+
if (typeof ResizeObserver === 'undefined' || !rootNode) {
|
|
38
37
|
return undefined;
|
|
39
38
|
}
|
|
40
39
|
const observer = new ResizeObserver(() => measureLayout());
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
observer.observe(parentNode);
|
|
40
|
+
observer.observe(rootNode);
|
|
41
|
+
const slotNode = slotRef.current;
|
|
42
|
+
if (slotNode) {
|
|
43
|
+
observer.observe(slotNode);
|
|
46
44
|
}
|
|
47
45
|
return () => observer.disconnect();
|
|
48
|
-
}, [measureLayout]);
|
|
46
|
+
}, [measureLayout, hasSlotAfter]);
|
|
49
47
|
useEffect(() => {
|
|
50
48
|
if (typeof document === 'undefined' || !document.fonts?.ready) {
|
|
51
49
|
return undefined;
|
|
@@ -62,15 +60,18 @@ export function AiShimmer({ text, variant = DEFAULT_VARIANT, size = DEFAULT_SIZE
|
|
|
62
60
|
cancelled = true;
|
|
63
61
|
};
|
|
64
62
|
}, [measureLayout, size, text, variant, weight]);
|
|
65
|
-
const spreadStartHeight = Math.max(contentHeight, fallbackHeight);
|
|
66
|
-
const spreadEndHeight = spreadStartHeight + END_HEIGHT_EXTRA;
|
|
67
63
|
const rootStyle = useMemo(() => ({
|
|
68
|
-
'--ai-shimmer-
|
|
69
|
-
'--ai-shimmer-
|
|
70
|
-
...(hasIcon && {
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
64
|
+
'--ai-shimmer-wave-gradient': WAVE_GRADIENT,
|
|
65
|
+
'--ai-shimmer-wave-width': `${2 * lineWidth}px`,
|
|
66
|
+
...(hasIcon && { '--ai-shimmer-icon-size': `${iconSize}px` }),
|
|
67
|
+
...(hasSlotAfter && { '--ai-shimmer-slot-offset': `${slotOffset}px` }),
|
|
68
|
+
}), [hasIcon, hasSlotAfter, iconSize, lineWidth, slotOffset]);
|
|
69
|
+
let lead = null;
|
|
70
|
+
if (hasIconNode) {
|
|
71
|
+
lead = (_jsxs("svg", { className: styles.leadIcon, "data-test-id": TEST_IDS.icon, "aria-hidden": true, children: [_jsxs("defs", { children: [_jsx("linearGradient", { id: gradientId, x1: '0', y1: '0', x2: '1', y2: '0', children: WAVE_STOPS.map(stop => (_jsx("stop", { offset: stop.offset, stopColor: waveStopColor(stop), stopOpacity: stop.opacity }, stop.offset))) }), _jsx("mask", { id: maskId, className: styles.leadMask, maskUnits: 'userSpaceOnUse', x: '0', y: '0', width: '100%', height: '100%', children: icon })] }), _jsxs("g", { mask: `url(#${maskId})`, children: [_jsx("rect", { className: styles.leadBase, width: '100%', height: '100%' }), _jsx("rect", { className: styles.leadWave, height: '100%', fill: `url(#${gradientId})` })] })] }));
|
|
72
|
+
}
|
|
73
|
+
else if (iconMask) {
|
|
74
|
+
lead = (_jsx("span", { className: styles.lead, style: { maskImage: iconMask, WebkitMaskImage: iconMask }, "data-test-id": TEST_IDS.icon, "aria-hidden": true }));
|
|
75
|
+
}
|
|
76
|
+
return (_jsxs("div", { ref: rootRef, className: cn(styles.root, className), style: rootStyle, "data-variant": variant, "data-size": size, "data-weight": weight, "data-has-icon": hasIcon || undefined, "data-has-slot": hasSlotAfter || undefined, "data-test-id": dataTestId, ...extractSupportProps(rest), children: [_jsxs("span", { ref: textRef, className: styles.text, "data-test-id": TEST_IDS.text, children: [lead, text] }), hasSlotAfter && (_jsx("span", { ref: slotRef, className: styles.slot, "data-test-id": TEST_IDS.slot, children: slotAfter }))] }));
|
|
76
77
|
}
|
package/dist/esm/constants.d.ts
CHANGED
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { AiShimmerSize, AiShimmerVariant, AiShimmerWeight } from './types.js';
|
|
2
2
|
export declare const TEST_IDS: {
|
|
3
3
|
readonly root: "ai-shimmer";
|
|
4
4
|
readonly text: "ai-shimmer__text";
|
|
5
|
-
readonly shimmer: "ai-shimmer__shimmer";
|
|
6
|
-
readonly spread: "ai-shimmer__spread";
|
|
7
5
|
readonly icon: "ai-shimmer__icon";
|
|
6
|
+
readonly slot: "ai-shimmer__slot";
|
|
8
7
|
};
|
|
9
8
|
/** Варианты типографики. */
|
|
10
9
|
export declare const VARIANT: Record<AiShimmerVariant, AiShimmerVariant>;
|
|
@@ -20,28 +19,50 @@ export declare const DEFAULT_SIZE: AiShimmerSize;
|
|
|
20
19
|
export declare const DEFAULT_WEIGHT: AiShimmerWeight;
|
|
21
20
|
/** Размер ведущей иконки по умолчанию (px), когда задан `iconMask`. */
|
|
22
21
|
export declare const DEFAULT_ICON_SIZE = 16;
|
|
23
|
-
/**
|
|
24
|
-
export declare const
|
|
25
|
-
export declare function fontMetricsForTypography(variant?: AiShimmerVariant, size?: AiShimmerSize, weight?: AiShimmerWeight): AiShimmerFontMetrics;
|
|
22
|
+
/** Ширина строки до первого замера DOM (SSR и первый рендер). */
|
|
23
|
+
export declare const DEFAULT_ROOT_WIDTH = 400;
|
|
26
24
|
/**
|
|
27
|
-
*
|
|
28
|
-
*
|
|
25
|
+
* Стопы волны: единственный источник для CSS-градиента текста и SVG-градиента иконки.
|
|
26
|
+
* Цвета литералами — токенов под них в `@cloud-ru/ds-figma-variables` пока нет.
|
|
29
27
|
*/
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
28
|
+
export declare const WAVE_STOPS: readonly [{
|
|
29
|
+
readonly offset: 0;
|
|
30
|
+
readonly rgb: readonly [51, 140, 235];
|
|
31
|
+
readonly opacity: 0;
|
|
32
|
+
}, {
|
|
33
|
+
readonly offset: 0.3;
|
|
34
|
+
readonly rgb: readonly [51, 140, 235];
|
|
35
|
+
readonly opacity: 0;
|
|
36
|
+
}, {
|
|
37
|
+
readonly offset: 0.4;
|
|
38
|
+
readonly rgb: readonly [51, 140, 235];
|
|
39
|
+
readonly opacity: 1;
|
|
40
|
+
}, {
|
|
41
|
+
readonly offset: 0.48;
|
|
42
|
+
readonly rgb: readonly [59, 174, 209];
|
|
43
|
+
readonly opacity: 1;
|
|
44
|
+
}, {
|
|
45
|
+
readonly offset: 0.54;
|
|
46
|
+
readonly rgb: readonly [67, 208, 183];
|
|
47
|
+
readonly opacity: 1;
|
|
48
|
+
}, {
|
|
49
|
+
readonly offset: 0.6;
|
|
50
|
+
readonly rgb: readonly [52, 203, 151];
|
|
51
|
+
readonly opacity: 1;
|
|
52
|
+
}, {
|
|
53
|
+
readonly offset: 0.68;
|
|
54
|
+
readonly rgb: readonly [36, 198, 118];
|
|
55
|
+
readonly opacity: 1;
|
|
56
|
+
}, {
|
|
57
|
+
readonly offset: 0.78;
|
|
58
|
+
readonly rgb: readonly [36, 198, 118];
|
|
59
|
+
readonly opacity: 0;
|
|
60
|
+
}, {
|
|
61
|
+
readonly offset: 1;
|
|
62
|
+
readonly rgb: readonly [36, 198, 118];
|
|
63
|
+
readonly opacity: 0;
|
|
64
|
+
}];
|
|
65
|
+
/** Цвет стопа как CSS `rgb()`: без альфы для SVG `stop-color`, с альфой — для градиента. */
|
|
66
|
+
export declare function waveStopColor({ rgb: [r, g, b], opacity }: (typeof WAVE_STOPS)[number], withAlpha?: boolean): string;
|
|
67
|
+
/** Те же стопы как CSS `linear-gradient` — уходит в стили через `--ai-shimmer-wave-gradient`. */
|
|
68
|
+
export declare const WAVE_GRADIENT: string;
|
package/dist/esm/constants.js
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
1
|
export const TEST_IDS = {
|
|
2
2
|
root: 'ai-shimmer',
|
|
3
3
|
text: 'ai-shimmer__text',
|
|
4
|
-
shimmer: 'ai-shimmer__shimmer',
|
|
5
|
-
spread: 'ai-shimmer__spread',
|
|
6
4
|
icon: 'ai-shimmer__icon',
|
|
5
|
+
slot: 'ai-shimmer__slot',
|
|
7
6
|
};
|
|
8
7
|
/** Варианты типографики. */
|
|
9
8
|
export const VARIANT = {
|
|
@@ -33,40 +32,26 @@ export const DEFAULT_SIZE = SIZE.m;
|
|
|
33
32
|
export const DEFAULT_WEIGHT = WEIGHT.regular;
|
|
34
33
|
/** Размер ведущей иконки по умолчанию (px), когда задан `iconMask`. */
|
|
35
34
|
export const DEFAULT_ICON_SIZE = 16;
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
lineHeight: 24,
|
|
39
|
-
fontWeight: '400',
|
|
40
|
-
};
|
|
41
|
-
/** Fallback-метрики body regular для расчёта высоты до замера DOM. */
|
|
42
|
-
export const TYPOGRAPHY_FONT_METRICS = {
|
|
43
|
-
'regular-body-s': { fontSize: 14, lineHeight: 20, fontWeight: '400' },
|
|
44
|
-
'regular-body-m': DEFAULT_FONT_METRICS,
|
|
45
|
-
'regular-body-l': { fontSize: 20, lineHeight: 28, fontWeight: '400' },
|
|
46
|
-
};
|
|
47
|
-
export function fontMetricsForTypography(variant = DEFAULT_VARIANT, size = DEFAULT_SIZE, weight = DEFAULT_WEIGHT) {
|
|
48
|
-
const key = `${weight}-${variant}-${size}`;
|
|
49
|
-
return TYPOGRAPHY_FONT_METRICS[key] ?? DEFAULT_FONT_METRICS;
|
|
50
|
-
}
|
|
35
|
+
/** Ширина строки до первого замера DOM (SSR и первый рендер). */
|
|
36
|
+
export const DEFAULT_ROOT_WIDTH = 400;
|
|
51
37
|
/**
|
|
52
|
-
*
|
|
53
|
-
*
|
|
38
|
+
* Стопы волны: единственный источник для CSS-градиента текста и SVG-градиента иконки.
|
|
39
|
+
* Цвета литералами — токенов под них в `@cloud-ru/ds-figma-variables` пока нет.
|
|
54
40
|
*/
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
export const MASK_TEXT_FONT_FAMILY = "'SB Sans Interface','Inter','Segoe UI',sans-serif";
|
|
41
|
+
export const WAVE_STOPS = [
|
|
42
|
+
{ offset: 0, rgb: [51, 140, 235], opacity: 0 },
|
|
43
|
+
{ offset: 0.3, rgb: [51, 140, 235], opacity: 0 },
|
|
44
|
+
{ offset: 0.4, rgb: [51, 140, 235], opacity: 1 },
|
|
45
|
+
{ offset: 0.48, rgb: [59, 174, 209], opacity: 1 },
|
|
46
|
+
{ offset: 0.54, rgb: [67, 208, 183], opacity: 1 },
|
|
47
|
+
{ offset: 0.6, rgb: [52, 203, 151], opacity: 1 },
|
|
48
|
+
{ offset: 0.68, rgb: [36, 198, 118], opacity: 1 },
|
|
49
|
+
{ offset: 0.78, rgb: [36, 198, 118], opacity: 0 },
|
|
50
|
+
{ offset: 1, rgb: [36, 198, 118], opacity: 0 },
|
|
51
|
+
];
|
|
52
|
+
/** Цвет стопа как CSS `rgb()`: без альфы для SVG `stop-color`, с альфой — для градиента. */
|
|
53
|
+
export function waveStopColor({ rgb: [r, g, b], opacity }, withAlpha = false) {
|
|
54
|
+
return withAlpha ? `rgb(${r} ${g} ${b} / ${opacity * 100}%)` : `rgb(${r} ${g} ${b})`;
|
|
55
|
+
}
|
|
56
|
+
/** Те же стопы как CSS `linear-gradient` — уходит в стили через `--ai-shimmer-wave-gradient`. */
|
|
57
|
+
export const WAVE_GRADIENT = `linear-gradient(90deg, ${WAVE_STOPS.map(stop => `${waveStopColor(stop, true)} ${stop.offset * 100}%`).join(', ')})`;
|