@cloud-ru/ds-attachment

中文文档
1.1.32发布于 2026/11/11Apache-2.0TypeScriptESM + CJS近 30 天下载 5838

Пакет компонентов для отображения прикреплённых файлов — Attachment (горизонтальный) и AttachmentSquare (квадратный).

原始使用文档
文档目录13 节
  1. Когда использовать
  2. Анатомия
  3. Установка
  4. Attachment
  5. Когда использовать
  6. Анатомия
  7. Примеры использования
  8. Props
  9. AttachmentSquare
  10. Когда использовать
  11. Анатомия
  12. Примеры использования
  13. Props

Attachment

@cloud-ru/ds-attachment — Пакет компонентов для отображения прикреплённых файлов — Attachment (горизонтальный) и AttachmentSquare (квадратный).

Пакет @cloud-ru/ds-attachment предоставляет два компонента для отображения прикреплённых файлов:

  • Attachment — горизонтальный список-айтем с иконкой/превью, заголовком, описанием и actions.
  • AttachmentSquare — квадратный тайл с hover-оверлеем; удобен для галерей превью.

Оба используют общие токены s / m, поддерживают loading/error/disabled/checked (множественный выбор) и автоматически показывают image-превью, если file — изображение.

Когда использовать

  • В списках прикреплённых файлов с возможностью скачать/удалить — Attachment.
  • В галереях превью со state hovered-overlay — AttachmentSquare.

Когда не нужен пакет: для drag&drop-загрузки — Dropzone; для одиночных preview-карточек без actions — Card.

Анатомия

Оба компонента строятся вокруг трёх слотов: превью (иконка или image из file), текстовый блок (заголовок + описание / сообщение об ошибке), панель actions (download / delete, или retry при error).

Установка

pnpm add @cloud-ru/ds-attachment
import { Attachment, AttachmentSquare } from '@cloud-ru/ds-attachment'

Attachment

Горизонтальный айтем прикреплённого файла с превью/иконкой, заголовком, описанием, ошибкой и actions (download/delete/retry).

Горизонтальный айтем прикреплённого файла. Слева — иконка типа файла или превью (если file — изображение), в середине — заголовок и описание (или сообщение об ошибке), справа — actions (download / delete, или retry в состоянии ошибки).

Когда использовать

  • В списках прикреплённых файлов с возможностью скачать/удалить.
  • Когда у вас есть File-объект — заголовок и расширение проставляются автоматически.

Когда не нужен Attachment:

  • Для галерей превью — используйте AttachmentSquare.
  • Для drag&drop загрузки — используйте Dropzone.

Анатомия

Size (default s)

  • s — компактная строка, высота 48px (emblem 32 + 2×8 padding).
  • m — увеличенная строка, высота 56px (emblem 40 + 2×8 padding).

Высота строки content-driven: задаётся размером emblem'а и вертикальным padding'ом Card-корня (8px фиксированно). Токены attachment.anatomy.size.*.container.height относятся к AttachmentSquare, а не к строке.

State

Состояния выражаются через смежные пропы (а не через одну ось):

  • loading — спиннер вместо иконки, actions скрыты.
  • disabled — карточка не реагирует на клик; actions всё равно доступны если passed onDelete/onDownload.
  • error — показывается ошибочное сообщение, action retry заменяет download; фон карточки переключается на red/background.
  • checked — accent-border primary/accent + accent-state-layer (activated/default/filled, на hover — activated/hovered/filled) поверх фона + check-badge в левом верхнем углу.

Внутри использует Card с view='outline'; реакция на курсор (cursor: pointer, focus-ring) подключается только если задан onClick.

Примеры использования

Базовый Attachment

File с автозаголовком и onDownload

import { Attachment } from '@cloud-ru/ds-attachment';

import { PDF_FILE } from './sample';

export function BasicAttachment() {
  return <Attachment file={PDF_FILE} onDownload={file => console.info('download', file?.name)} />;
}

С изображением

Превью автоматически из image-файла через useImage

import { Attachment } from '@cloud-ru/ds-attachment';
import { useEffect, useState } from 'react';

import pictureUrl from './picture.jpg?url';

export function AttachmentWithImage() {
  const [file, setFile] = useState<File>();

  useEffect(() => {
    fetch(pictureUrl)
      .then(r => r.blob())
      .then(blob => setFile(new File([blob], 'picture.jpg', { type: 'image/jpg' })));
  }, []);

  return (
    <Attachment
      file={file}
      title='Скриншот'
      description='JPG'
      onDownload={f => console.info('download', f?.name)}
      onDelete={f => console.info('delete', f?.name)}
    />
  );
}

Loading

Спиннер вместо иконки, actions скрыты

import { Attachment } from '@cloud-ru/ds-attachment';

import { PDF_FILE } from './sample';

export function AttachmentLoading() {
  return <Attachment file={PDF_FILE} loading />;
}

Ошибка с retry

error заменяет description; retry button заменяет download

import { Attachment } from '@cloud-ru/ds-attachment';
import { useState } from 'react';

import { PDF_FILE } from './sample';

export function AttachmentError() {
  const [retries, setRetries] = useState(0);

  return (
    <Attachment
      file={PDF_FILE}
      error={`Не удалось загрузить (попыток: ${retries})`}
      onRetry={() => setRetries(n => n + 1)}
      onDelete={file => console.info('delete', file?.name)}
    />
  );
}

Выбираемый (controlled)

checked + onClick — типичный паттерн multiSelect

import { Attachment } from '@cloud-ru/ds-attachment';
import { useState } from 'react';

import { PDF_FILE } from './sample';

export function AttachmentSelectable() {
  const [checked, setChecked] = useState(false);

  return (
    <Attachment
      file={PDF_FILE}
      checked={checked}
      onClick={() => setChecked(v => !v)}
      onDelete={file => console.info('delete', file?.name)}
    />
  );
}

Props

AttachmentProps

PropTypeDefaultDescription
checkedboolean—Состояние «выбран» (множественный выбор)
classNamestring—CSS-класс корня
data-test-idstring—
descriptionstringfileExtensionОписание
disabledboolean—Заблокировано
errorstring—Сообщение об ошибке
fileFile—Файл
fullWidthbooleantrueРастянуть карточку на всю ширину контейнера. Выключенная — ужимается по содержимому.
iconJSXElementConstructor<{ size?: number; className?: string; }> | undefined—Иконка для файла
@defaultIcon FileSVG
loadingboolean—Управление состоянием загрузки
onClick((event: MouseEvent<HTMLDivElement, MouseEvent>) => void)—Клик по карточке
onDelete((file?: File) => void)—Колбек на клик по кнопке удаления
onDownload((file?: File) => void)—Колбек на клик по кнопке скачивания
onRetry(() => void)—Колбек на клик по кнопке повторения
size"m" | "s"sРазмер
titlestringfileNameЗаголовок
truncate{ title?: number; description?: number; error?: number | undefined; } | undefined—
truncateVariant"end" | "middle"—Вариант обрезания строки:

- end — с конца;

- middle — по середине
  • Size = "m" | "s"

AttachmentSquare

Квадратный тайл прикреплённого файла с hover-оверлеем — для галерей превью и компактных списков.

Квадратный тайл прикреплённого файла. По умолчанию показывает превью или иконку; при hover (или фокусе на actions) поверх появляется overlay с заголовком/описанием и actions.

Когда использовать

  • В галереях превью и сетках, где у файлов есть визуальный смысл.
  • Когда важна плотность — s (80×80) и m (100×100).

Анатомия

Size (default s)

  • s — 80×80.
  • m — 100×100.

Hover-overlay

При hover и при фокусе на любой action-кнопке (download/delete/retry) над основным контентом появляется overlay с заголовком/описанием и actions. В image-mode overlay плотный (solid neutral/background1Level) и перекрывает превью; в icon-mode — прозрачный, текст MainContent проступает сквозь, а Actions подменяют слот иконки. Состояние «фокус удерживает overlay» реализовано через внутренний контекст AttachmentFocusActionsContext.

State

  • loading — спиннер вместо превью, actions скрыты, hover-overlay отключён.
  • disabled — карточка не реагирует на клик, opacity снижается до effect/opacity/disabled.
  • error — фон тайла переключается на red/background, action retry заменяет download; в error-режиме overlay прозрачный, чтобы красная заливка пропускалась.
  • checked — accent-border + собственный checkedOverlay поверх MainContent с токенами activated/default/filled → activated/hovered/filled (Card-овский state-layer закрыт full-bleed image, поэтому overlay рендерится отдельным слоем). Check-badge в верхнем левом углу.

Примеры использования

Базовый

Файл с иконкой и кнопками

import { AttachmentSquare } from '@cloud-ru/ds-attachment';

import { PDF_FILE } from './sample';

export function AttachmentSquareBasic() {
  return (
    <AttachmentSquare
      file={PDF_FILE}
      onDownload={file => console.info('download', file?.name)}
      onDelete={file => console.info('delete', file?.name)}
    />
  );
}

С изображением (size m)

Превью автоматически из image-файла

import { AttachmentSquare } from '@cloud-ru/ds-attachment';
import { useEffect, useState } from 'react';

import pictureUrl from './picture.jpg?url';

export function AttachmentSquareImage() {
  const [file, setFile] = useState<File>();

  useEffect(() => {
    fetch(pictureUrl)
      .then(r => r.blob())
      .then(blob => setFile(new File([blob], 'picture.jpg', { type: 'image/jpg' })));
  }, []);

  return (
    <AttachmentSquare
      size='m'
      file={file}
      onDownload={f => console.info('download', f?.name)}
      onDelete={f => console.info('delete', f?.name)}
    />
  );
}

Props

AttachmentSquareProps

PropTypeDefaultDescription
checkedboolean—Состояние «выбран» (множественный выбор)
classNamestring—CSS-класс корня
data-test-idstring—
descriptionstringfileExtensionОписание
disabledboolean—Заблокировано
errorstring—Сообщение об ошибке
fileFile—Файл
iconJSXElementConstructor<{ size?: number; className?: string; }> | undefined—Иконка для файла
@defaultIcon FileSVG
loadingboolean—Управление состоянием загрузки
onClick((event: MouseEvent<HTMLDivElement, MouseEvent>) => void)—Клик по карточке
onDelete((file?: File) => void)—Колбек на клик по кнопке удаления
onDownload((file?: File) => void)—Колбек на клик по кнопке скачивания
onRetry(() => void)—Колбек на клик по кнопке повторения
size"m" | "s"sРазмер
titlestringfileNameЗаголовок
truncateVariant"end" | "middle"—Вариант обрезания строки:

- end — с конца;

- middle — по середине
  • Size = "m" | "s"

版本与发布记录

@cloud-ru/ds-attachment 共发布 143 个版本,首次发布于 2026/08/18;过去 12 个月发布了 143 个版本。

版本发布日期距今
1.1.32latest2026/11/11今天
1.1.32-preview-e8fe6b56.0preview2026/11/11今天
1.1.32-preview-c0e895ed.02026/11/11今天
1.1.32-preview-90b10112.02026/11/11今天
1.1.32-preview-fd7dd437.02026/11/101 天前
1.1.32-preview-9a75a2a9.02026/11/101 天前

关于 @cloud-ru/ds-attachment 的常见问题

@cloud-ru/ds-attachment 是什么?

Пакет компонентов для отображения прикреплённых файлов — Attachment (горизонтальный) и AttachmentSquare (квадратный).

如何安装 @cloud-ru/ds-attachment?

在项目目录运行 npm install @cloud-ru/ds-attachment,或使用 pnpm add / yarn add / bun add。

@cloud-ru/ds-attachment 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@cloud-ru/ds-attachment 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@cloud-ru/ds-attachment 可以商用吗?

@cloud-ru/ds-attachment 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@cloud-ru/ds-attachment 的下载量有多少?

根据 npm 官方下载统计,@cloud-ru/ds-attachment 在 2026/10/10 – 2026/11/08 这 30 天内被下载 5,838 次,日均约 195 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@cloud-ru/ds-attachment 还在维护吗?

最新版本 1.1.32 发布于 2026/11/11(今天);至今共发布 143 个版本,其中过去 12 个月发布了 143 个;首次发布于 2026/08/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。