chore: Add comments to Token related interfaces (#50392)

This commit is contained in:
Arvin Xu 2024-08-13 18:18:59 +08:00 committed by GitHub
parent b3c01de9bc
commit 51d6a9bf38
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
27 changed files with 549 additions and 2 deletions

View File

@ -4,6 +4,10 @@ import type { FullToken, GenerateStyle, GetDefaultToken } from '../../theme/inte
import { genStyleHooks } from '../../theme/internal';
export interface ComponentToken {
/**
* @desc z-index
* @descEN z-index of popup
*/
zIndexPopup: number;
}

View File

@ -17,10 +17,30 @@ export interface ComponentToken {
linkPaddingInlineStart: number;
}
/**
* @desc Anchor Token
* @descEN Token for Anchor component
*/
interface AnchorToken extends FullToken<'Anchor'> {
/**
* @desc
* @descEN Holder block offset
*/
holderOffsetBlock: number;
/**
* @desc
* @descEN Secondary anchor block padding
*/
anchorPaddingBlockSecondary: number | string;
/**
* @desc
* @descEN Anchor ball size
*/
anchorBallSize: number | string;
/**
* @desc
* @descEN Anchor title block
*/
anchorTitleBlock: number | string;
}

View File

@ -53,6 +53,10 @@ export interface ComponentToken {
groupBorderColor: string;
}
/**
* @desc Avatar Token
* @descEN Token for Avatar component
*/
type AvatarToken = FullToken<'Avatar'> & {
avatarBgColor: string;
avatarBg: string;

View File

@ -7,20 +7,60 @@ import { genStyleHooks, mergeToken } from '../../theme/internal';
/** Component only token. Which will handle additional calculation of alias token */
export interface ComponentToken {
/**
* @desc z-index
* @descEN z-index of popup
*/
zIndexPopup: number;
}
type BackTopToken = FullToken<'BackTop'> & {
/**
* @desc BackTop
* @descEN Background color of BackTop
*/
backTopBackground: string;
/**
* @desc BackTop
* @descEN Text color of BackTop
*/
backTopColor: string;
/**
* @desc BackTop
* @descEN Hover background color of BackTop
*/
backTopHoverBackground: string;
/**
* @desc BackTop
* @descEN Font size of BackTop
*/
backTopFontSize: number;
/**
* @desc BackTop
* @descEN Size of BackTop
*/
backTopSize: number;
// Position
/**
* @desc BackTop
* @descEN Bottom offset of BackTop
*/
backTopBlockEnd: number | string;
/**
* @desc BackTop
* @descEN Right offset of BackTop
*/
backTopInlineEnd: number | string;
/**
* @desc BackTop
* @descEN Right offset of BackTop on medium screens
*/
backTopInlineEndMD: number | string;
/**
* @desc BackTop
* @descEN Right offset of BackTop on small screens
*/
backTopInlineEndXS: number | string;
};

View File

@ -49,16 +49,60 @@ export interface ComponentToken {
statusSize: number;
}
/**
* @desc Badge Token
* @descEN Token for Badge component
*/
export interface BadgeToken extends FullToken<'Badge'> {
/**
* @desc
* @descEN Font height of badge
*/
badgeFontHeight: number;
/**
* @desc
* @descEN Text color of badge
*/
badgeTextColor: string;
/**
* @desc
* @descEN Color of badge
*/
badgeColor: string;
/**
* @desc
* @descEN Hover color of badge
*/
badgeColorHover: string;
/**
* @desc
* @descEN Shadow size of badge
*/
badgeShadowSize: number;
/**
* @desc
* @descEN Shadow color of badge
*/
badgeShadowColor: string;
/**
* @desc
* @descEN Processing duration of badge
*/
badgeProcessingDuration: string;
/**
* @desc
* @descEN Ribbon offset of badge
*/
badgeRibbonOffset: number;
/**
* @desc
* @descEN Ribbon corner transform of badge
*/
badgeRibbonCornerTransform: string;
/**
* @desc
* @descEN Ribbon corner filter of badge
*/
badgeRibbonCornerFilter: string;
}

View File

@ -45,9 +45,25 @@ export interface ComponentToken {
}
interface CalendarToken extends FullToken<'Calendar'>, PickerPanelToken, PanelComponentToken {
/**
* @desc
* @descEN Calendar class name
*/
calendarCls: string;
/**
* @desc
* @descEN Date value height
*/
dateValueHeight: number | string;
/**
* @desc
* @descEN Week height
*/
weekHeight: number | string;
/**
* @desc
* @descEN Date content height
*/
dateContentHeight: number | string;
}

View File

@ -7,8 +7,20 @@ import { genStyleHooks, mergeToken } from '../../theme/internal';
// biome-ignore lint/suspicious/noEmptyInterface: ComponentToken need to be empty by default
export interface ComponentToken {}
/**
* @desc Checkbox Token
* @descEN Token for Checkbox component
*/
interface CheckboxToken extends FullToken<'Checkbox'> {
/**
* @desc Checkbox
* @descEN Checkbox class name
*/
checkboxCls: string;
/**
* @desc Checkbox
* @descEN Size of Checkbox
*/
checkboxSize: number;
}

View File

@ -13,15 +13,55 @@ import genSliderStyle from './slider';
// biome-ignore lint/suspicious/noEmptyInterface: ComponentToken need to be empty by default
export interface ComponentToken {}
/**
* @desc ColorPicker Token
* @descEN Token for ColorPicker component
*/
export interface ColorPickerToken extends FullToken<'ColorPicker'> {
/**
* @desc ColorPicker
* @descEN Width of ColorPicker
*/
colorPickerWidth: number;
/**
* @desc ColorPicker
* @descEN Inset shadow of ColorPicker
*/
colorPickerInsetShadow: string;
/**
* @desc ColorPicker
* @descEN Handler size of ColorPicker
*/
colorPickerHandlerSize: number;
/**
* @desc ColorPicker
* @descEN Small handler size of ColorPicker
*/
colorPickerHandlerSizeSM: number;
/**
* @desc ColorPicker
* @descEN Slider height of ColorPicker
*/
colorPickerSliderHeight: number;
/**
* @desc ColorPicker
* @descEN Preview size of ColorPicker
*/
colorPickerPreviewSize: number;
/**
* @desc ColorPicker Alpha
* @descEN Alpha input width of ColorPicker
*/
colorPickerAlphaInputWidth: number;
/**
* @desc ColorPicker
* @descEN Input number handle width of ColorPicker
*/
colorPickerInputNumberHandleWidth: number;
/**
* @desc ColorPicker
* @descEN Preset color size of ColorPicker
*/
colorPickerPresetColorSize: number;
}

View File

@ -25,9 +25,25 @@ export interface ComponentToken {
verticalMarginInline: CSSProperties['marginInline'];
}
/**
* @desc Divider Token
* @descEN Token for Divider component
*/
interface DividerToken extends FullToken<'Divider'> {
/**
* @desc
* @descEN Size padding edge horizontal
*/
sizePaddingEdgeHorizontal: number | string;
/**
* @desc 线
* @descEN Horizontal margin of divider with text
*/
dividerHorizontalWithTextGutterMargin: number | string;
/**
* @desc 线
* @descEN Horizontal margin of divider
*/
dividerHorizontalGutterMargin: number | string;
}

View File

@ -32,9 +32,25 @@ export interface ComponentToken extends ArrowToken, ArrowOffsetToken {
paddingBlock: CSSProperties['paddingBlock'];
}
/**
* @desc Dropdown Token
* @descEN Token for Dropdown component
*/
export interface DropdownToken extends FullToken<'Dropdown'> {
/**
* @desc
* @descEN Distance of dropdown arrow
*/
dropdownArrowDistance: number | string;
/**
* @desc
* @descEN Padding of edge child in dropdown menu
*/
dropdownEdgeChildPadding: number;
/**
* @desc
* @descEN Menu class name
*/
menuCls: string;
}

View File

@ -7,10 +7,30 @@ import { genStyleHooks, mergeToken } from '../../theme/internal';
// biome-ignore lint/suspicious/noEmptyInterface: ComponentToken need to be empty by default
export interface ComponentToken {}
/**
* @desc Empty Token
* @descEN Token for Empty component
*/
interface EmptyToken extends FullToken<'Empty'> {
/**
* @desc
* @descEN Class name for empty state image
*/
emptyImgCls: string;
/**
* @desc
* @descEN Height of empty state image
*/
emptyImgHeight: number | string;
/**
* @desc
* @descEN Height of small empty state image
*/
emptyImgHeightSM: number | string;
/**
* @desc
* @descEN Height of medium empty state image
*/
emptyImgHeightMD: number | string;
}

View File

@ -22,19 +22,68 @@ export interface ComponentToken {
dotOffsetInSquare: number;
}
/**
* @desc FloatButton Token
* @descEN Token for FloatButton component
*/
type FloatButtonToken = FullToken<'FloatButton'> & {
/**
* @desc FloatButton
* @descEN Color of FloatButton
*/
floatButtonColor: string;
/**
* @desc FloatButton
* @descEN Background color of FloatButton
*/
floatButtonBackgroundColor: string;
/**
* @desc FloatButton
* @descEN Hover background color of FloatButton
*/
floatButtonHoverBackgroundColor: string;
/**
* @desc FloatButton
* @descEN Font size of FloatButton
*/
floatButtonFontSize: number;
/**
* @desc FloatButton
* @descEN Size of FloatButton
*/
floatButtonSize: number;
/**
* @desc FloatButton
* @descEN Icon size of FloatButton
*/
floatButtonIconSize: number | string;
/**
* @desc FloatButton
* @descEN Body size of FloatButton
*/
floatButtonBodySize: number | string;
/**
* @desc FloatButton
* @descEN Body padding of FloatButton
*/
floatButtonBodyPadding: number;
/**
* @desc
* @descEN Offset of badge
*/
badgeOffset: number | string;
// Position
/**
* @desc FloatButton
* @descEN Bottom inset of FloatButton
*/
floatButtonInsetBlockEnd: number;
/**
* @desc FloatButton
* @descEN Right inset of FloatButton
*/
floatButtonInsetInlineEnd: number;
};

View File

@ -67,8 +67,20 @@ export interface ComponentToken {
verticalLabelMargin: CSSProperties['margin'];
}
/**
* @desc Form Token
* @descEN Token for Form component
*/
export interface FormToken extends FullToken<'Form'> {
/**
* @desc
* @descEN Form item class name
*/
formItemCls: string;
/**
* @desc
* @descEN Root prefix class name
*/
rootPrefixCls: string;
}

View File

@ -12,6 +12,10 @@ interface GridRowToken extends FullToken<'Grid'> {
}
interface GridColToken extends FullToken<'Grid'> {
/**
* @desc
* @descEN Number of grid columns
*/
gridColumns: number;
}

View File

@ -36,9 +36,25 @@ export interface ComponentToken {
previewOperationColorDisabled: string;
}
/**
* @desc Image Token
* @descEN Token for Image component
*/
export interface ImageToken extends FullToken<'Image'> {
/**
* @desc
* @descEN Preview class name
*/
previewCls: string;
/**
* @desc
* @descEN Background color of modal mask
*/
modalMaskBg: string;
/**
* @desc
* @descEN Size of preview switch button
*/
imagePreviewSwitchSize: number;
}

View File

@ -64,8 +64,20 @@ export interface ComponentToken {
descriptionFontSize: number;
}
/**
* @desc List Token
* @descEN Token for List component
*/
interface ListToken extends FullToken<'List'> {
/**
* @desc
* @descEN Class name of list item
*/
listBorderedCls: string;
/**
* @desc
* @descEN Minimum height
*/
minHeight: number | string;
}

View File

@ -35,8 +35,16 @@ export interface ComponentToken extends SharedComponentToken {
controlItemWidth: number | string;
}
/**
* @desc Mentions Token
* @descEN Token for Mentions component
*/
type MentionsToken = FullToken<'Mentions'> &
SharedInputToken & {
/**
* @desc
* @descEN Padding of menu item
*/
itemPaddingVertical: string | number;
};

View File

@ -369,11 +369,35 @@ export interface ComponentToken {
itemWidth: number | string;
}
/**
* @desc Menu Token
* @descEN Token for Menu component
*/
export interface MenuToken extends FullToken<'Menu'> {
/**
* @desc
* @descEN Height of horizontal menu
*/
menuHorizontalHeight: number | string;
/**
* @desc
* @descEN Size of menu arrow
*/
menuArrowSize: number | string;
/**
* @desc
* @descEN Offset of menu arrow
*/
menuArrowOffset: number | string;
/**
* @desc
* @descEN Background color of sub-menu
*/
menuSubMenuBg: string;
/**
* @desc
* @descEN Background color of popup menu in dark mode
*/
darkPopupBg: string;
}

View File

@ -1,4 +1,3 @@
// deps-lint-skip-all
import type { CSSProperties } from 'react';
import type { CSSObject } from '@ant-design/cssinjs';
import { Keyframes } from '@ant-design/cssinjs';
@ -28,8 +27,16 @@ export interface ComponentToken {
contentPadding: CSSProperties['padding'];
}
/**
* @desc Message Token
* @descEN Token for Message component
*/
interface MessageToken extends FullToken<'Message'> {
// Custom token here
/**
* @desc
* @descEN Height of Message
*/
height: number;
}

View File

@ -73,16 +73,55 @@ export interface ComponentToken {
confirmBtnsMarginTop: string | number;
}
/**
* @desc Modal Token
* @descEN Token for Modal component
*/
export interface ModalToken extends FullToken<'Modal'> {
// Custom token here
/**
* @desc
* @descEN Height of modal header
*/
modalHeaderHeight: number | string;
/**
* @desc
* @descEN Border color of modal footer
*/
modalFooterBorderColorSplit: string;
/**
* @desc
* @descEN Border style of modal footer
*/
modalFooterBorderStyle: string;
/**
* @desc
* @descEN Border width of modal footer
*/
modalFooterBorderWidth: number | string;
/**
* @desc
* @descEN Color of modal close icon
*/
modalCloseIconColor: string;
/**
* @desc
* @descEN Hover color of modal close icon
*/
modalCloseIconHoverColor: string;
/**
* @desc
* @descEN Size of modal close button
*/
modalCloseBtnSize: number | string;
/**
* @desc
* @descEN Size of modal confirm icon
*/
modalConfirmIconSize: number | string;
/**
* @desc
* @descEN Height of modal title
*/
modalTitleHeight: number | string;
}

View File

@ -22,18 +22,70 @@ export interface ComponentToken {
width: number | string;
}
/**
* @desc Notification Token
* @descEN Token for Notification component
*/
export interface NotificationToken extends FullToken<'Notification'> {
/**
* @desc
* @descEN Maximum height of animation
*/
animationMaxHeight: number | string;
/**
* @desc
* @descEN Background color of Notification
*/
notificationBg: string;
/**
* @desc
* @descEN Padding of Notification
*/
notificationPadding: string;
/**
* @desc
* @descEN Vertical padding of Notification
*/
notificationPaddingVertical: number;
/**
* @desc
* @descEN Horizontal padding of Notification
*/
notificationPaddingHorizontal: number;
/**
* @desc
* @descEN Icon size of Notification
*/
notificationIconSize: number | string;
/**
* @desc
* @descEN Close button size of Notification
*/
notificationCloseButtonSize: number | string;
/**
* @desc
* @descEN Bottom margin of Notification
*/
notificationMarginBottom: number;
/**
* @desc
* @descEN Edge margin of Notification
*/
notificationMarginEdge: number;
/**
* @desc
* @descEN Stack layer of Notification
*/
notificationStackLayer: number;
/**
* @desc
* @descEN Background color of Notification progress bar
*/
notificationProgressBg: string;
/**
* @desc
* @descEN Height of Notification progress bar
*/
notificationProgressHeight: number;
}

View File

@ -61,17 +61,53 @@ export interface ComponentToken {
miniOptionsSizeChangerTop: number;
}
/**
* @desc Pagination Token
* @descEN Token for Pagination component
*/
export interface PaginationToken
extends FullToken<'Pagination'>,
SharedComponentToken,
SharedInputToken {
/**
* @desc
* @descEN Outline offset of input
*/
inputOutlineOffset: number;
/**
* @desc
* @descEN Horizontal margin of mini options
*/
paginationMiniOptionsMarginInlineStart: number | string;
/**
* @desc
* @descEN Width of mini quick jumper input
*/
paginationMiniQuickJumperInputWidth: number | string;
/**
* @desc
* @descEN Horizontal padding of Pagination item
*/
paginationItemPaddingInline: number | string;
/**
* @desc
* @descEN Letter spacing of ellipsis
*/
paginationEllipsisLetterSpacing: number | string;
/**
* @desc
* @descEN Text indent of ellipsis
*/
paginationEllipsisTextIndent: string;
/**
* @desc
* @descEN Horizontal margin of slash
*/
paginationSlashMarginInlineStart: number;
/**
* @desc
* @descEN Horizontal margin of slash
*/
paginationSlashMarginInlineEnd: number;
}

View File

@ -9,6 +9,10 @@ export interface ComponentToken {
zIndexPopup: number;
}
/**
* @desc Popconfirm Token
* @descEN Token for Popconfirm component
*/
export interface PopconfirmToken extends FullToken<'Popconfirm'> {}
// =============================== Base ===============================

View File

@ -47,8 +47,20 @@ export interface ComponentToken extends ArrowToken, ArrowOffsetToken {
innerContentPadding: number | string;
}
/**
* @desc Popover Token
* @descEN Token for Popover component
*/
export type PopoverToken = FullToken<'Popover'> & {
/**
* @desc
* @descEN Background color of Popover
*/
popoverBg: string;
/**
* @desc
* @descEN Text color of Popover
*/
popoverColor: string;
};

View File

@ -41,9 +41,25 @@ export interface ComponentToken {
export const LineStrokeColorVar = '--progress-line-stroke-color';
export const Percent = '--progress-percent';
/**
* @desc Progress Token
* @descEN Token for Progress component
*/
interface ProgressToken extends FullToken<'Progress'> {
/**
* @desc
* @descEN Minimum width of progress step
*/
progressStepMinWidth: number | string;
/**
* @desc
* @descEN Right margin of progress step
*/
progressStepMarginInlineEnd: number | string;
/**
* @desc
* @descEN Duration of progress bar animation
*/
progressActiveMotionDuration: string;
}

View File

@ -8,8 +8,20 @@ import { genStyleHooks, mergeToken } from '../../theme/internal';
// biome-ignore lint/suspicious/noEmptyInterface: ComponentToken need to be empty by default
export interface ComponentToken {}
/**
* @desc QRCode Token
* @descEN Token for QRCode component
*/
interface QRCodeToken extends FullToken<'QRCode'> {
/**
* @desc QRCode
* @descEN Text color of QRCode
*/
QRCodeTextColor: string;
/**
* @desc QRCode
* @descEN Mask background color of QRCode
*/
QRCodeMaskBackgroundColor: string;
}

View File

@ -86,8 +86,20 @@ export interface ComponentToken {
radioBgColor: string;
}
/**
* @desc Radio Token
* @descEN Token for Radio component
*/
interface RadioToken extends FullToken<'Radio'> {
/**
* @desc
* @descEN Focus shadow of Radio
*/
radioFocusShadow: string;
/**
* @desc
* @descEN Focus shadow of Radio button
*/
radioButtonFocusShadow: string;
}