packages/avatar/src/types.ts - develop - kaws/ui-kit-ce

packages/avatar/src/types.ts

70 строк2 KB

Denis Svyatovets

style: добавлен плагин eslint для jsDoc

27 янв 2025, 17:06

27 янв 2025, 17:066287359

import {
  AvatarKind,
  AvatarSize,
  AvatarGroupColoring,
  AvatarGroupSize,
} from './constants'
import { AvatarClasses } from './classes'
import type {
  ComponentPropsWithRefFix,
  ComponentPropsWithAttributes,
} from '@v-uik/common'

export type AvatarSizeType = keyof typeof AvatarSize

export type AvatarKindType = keyof typeof AvatarKind

export type AvatarGroupColoringType = keyof typeof AvatarGroupColoring

export type AvatarGroupSizeType = keyof typeof AvatarGroupSize

export type AvatarProps = Omit<ComponentPropsWithRefFix<'div'>, 'ref'> & {
  /**
   * CSS классы компонента.
   */
  classes?: AvatarClasses
  /**
   * Размер аватара.
   */
  size?: AvatarSizeType | number
  /**
   * `svg` иконка.
   */
  icon?: React.ReactNode
  /**
   * Тип скругления аватара.
   */
  kind?: AvatarKindType
  /**
   * Свойство определяющее цвет аватара.
   */
  color?: React.CSSProperties['color']
  /**
   * Путь до изображения.
   */
  src?: string
  /**
   * Подпись для изображения.
   */
  alt?: string
  /**
   * HTML свойства для элемента `img`.
   */
  imgProps?: ComponentPropsWithAttributes<ComponentPropsWithRefFix<'img'>>
  /**
   * Заглушка, которая будет отображаться, если изображение не загрузилось и отсутствует `alt`, `icon` и `children`.
   */
  fallback?: React.ReactNode
  /**
   * Флаг отображения тени вокруг аватара.
   */
  withShadow?: boolean
  /**
   * Флаг отображения рамки вокруг аватара.
   */
  withBorder?: boolean
  /**
   * Дочерний `JSX`.
   */
  children?: string | React.ReactNode
}