feat: component docs, utils modularization & antd v6 storybook migration - #13
Merged
Conversation
- Move every component's API doc (including the 8 previously inline strings and VirtualTextViewer's i18n key) into <Name>.apidoc.md, imported with Vite ?raw. - Remove the now-duplicated VirtualTextViewer.docs.component key from en-US/zh-CN. - Each doc is organized by the component's own characteristics (overview, when-to-use, API table, notes/usage) rather than a fixed template. - Preserves the existing autodocs render pipeline and EN/CN language toggle. Co-Authored-By: Hermes <noreply@hermes.ai>
…ith index.stories.tsx - Split each flat XXX.stories.tsx + XXX.apidoc.md into a per-component folder - Rename main story to index.stories.tsx (matches Iconfont convention) - Split apidoc.md at '## API' into introduce.md (intro/usage) + api-doc.md (API tables) - Update import depths and docs description (introduce + apiDoc) - 15 components migrated: BreakLines, ColumnSetting, ConfigProvider, ConfirmAction, ContextMenu, DeleteConfirmAction, EditableText, EllipsisTypography, FloatDrawer, FormItemControl, Loading, ModalAction, OverflowTags, PulseAnimation, VirtualTextViewer - Verified via build-storybook (all index.stories.tsx scanned) and prettier
- Align with OverflowTags: each component folder now has introduce.en-US.md, introduce.zh-CN.md, api-doc.en-US.md, api-doc.zh-CN.md - Split the previously bilingual (- **EN:** / - **CN:**) blocks and dual-language headings (## When to use | 适用场景, ## Notes | 说明) into separate locale files - Drop the '# Component' title line from intro docs (matches OverflowTags) - Update index.stories.tsx to import all four locale docs and switch the component description via storyI18n.language === 'zh-CN' ? CN : EN - Components covered: BreakLines, ColumnSetting, ConfigProvider, ConfirmAction, ContextMenu, DeleteConfirmAction, EditableText, EllipsisTypography, FloatDrawer, FormItemControl, Iconfont, Loading, ModalAction, PulseAnimation, VirtualTextViewer - Note: API table Description cells in en-US/zh-CN files keep the original English text (no CN translation added); bilingual narrative blocks are fully separated - Verified via build-storybook (all 16 component stories scanned)
…sources
- Extract inline bilingual (- **EN:** / - **CN:**) description strings from
argTypes[prop].description and story.parameters.docs.description.story across
7 components into storybook.stories.<Comp>.{argTypes.<prop>|stories.<Story>}.description
keys in en-US.ts / zh-CN.ts
- Replace inline strings with storyT('...') references (consistent with BreakLines pattern)
- EllipsisTypography's repeated 'text' description is merged into one shared key since
the underlying text is identical across its four sub-stories
- Components covered: ConfirmAction, DeleteConfirmAction, EditableText, EllipsisTypography,
Iconfont, ModalAction, PulseAnimation
- Verified via build-storybook (all 16 component stories scanned) and prettier
…i-doc tables
- Reorder every api-doc table column so the Description/说明 column sits
immediately after the prop/field/method/参数/属性/方法 name column (2nd column)
- Affected tables include both primary component prop tables and nested type
tables (ColumnSettingItem, ContextMenuItem/Submenu/Separator, ContextMenuRef)
- Order becomes: Name | Description | Type | (Default) (or Name | Description | Type)
- Applied to all 16 api-doc.{en-US,zh-CN}.md files; prettier-formatted
…ction, ContextMenu) - Add structured bilingual introduce sections (Overview / When to use / Key features / Usage notes) to BreakLines, ConfirmAction, ContextMenu - ConfirmAction: add api-doc.en-US/zh-CN.md (component-specific props + ref methods) and wire it into index.stories.tsx imports/description - All content derived from component source (Props JSDoc, behavior) - prettier-formatted; build-storybook verified
- Add structured bilingual introduce (Overview / When to use / Key features / Usage notes) for all 16 components - Add api-doc.en-US/zh-CN for the 7 components that lacked one (ConfigProvider, DeleteConfirmAction, EditableText, EllipsisTypography, ModalAction, PulseAnimation, VirtualTextViewer), wiring imports + description in each index.stories.tsx - api-doc rule: list component-specific props fully + core/inherited props (not exhaustive) - All content derived from component source (Props + behavior) - prettier-formatted; build-storybook verified
…rkdown docs - Convert flat hooks stories (useDebounce, useAudioPlayer, useStreamDownloader) to per-hook folders with bilingual introduce + api-doc markdown - Align Utils/StreamDownloader story with the same component doc standard - Wire index.stories.tsx component descriptions via storyI18n.language ternary - Remove un-referenced stray introduce.mdx in Utils/StreamDownloader
…loader and related components
…g hooks - Add component-standard markdown docs (introduce.en-US.md, introduce.zh-CN.md, api-doc.en-US.md, api-doc.zh-CN.md) and index.stories.tsx for: useLocalStorage, useMovable, useProcessingText, useRefFunction, useRefValue, useRowSelection, useSplitter, useSSE, useStompSocket, useUserMedia, useValidators, useValidator, useValidatorBuilder - Update locale files (en-US.ts, zh-CN.ts) with 162 new i18n keys for all 13 hooks - All stories follow the established pattern: storyI18n.language ternary for component description, ?raw imports for markdown, t()/useStoryT() for UI strings - Verified: prettier, tsc, build-storybook all pass
- Updated useMovable hook to accept viewPortRef for container-bound movement. - Added onMove callback to notify position changes during dragging. - Improved API documentation for useMovable with clearer parameter descriptions. - Refactored useMovable implementation to handle viewport size and position clamping more effectively. - Enhanced Storybook examples for useMovable to demonstrate new features. - Updated various components to use title prop for Alert messages instead of message prop for consistency. - Improved documentation for several components and hooks to clarify default values and usage.
…ed APIs - useMovable: adapt tests to the new viewport-aware API (movableDomRef, viewPortRef, onMove callback, pointer capture fallbacks). Cover all branches including viewport rect fallbacks, clamp without dom ref, persistence + onMove on clamp, and pointermove when not dragging. - useSplitter: switch event simulation from mouse to pointer events (pointerDown/pointerEnter/pointerLeave) to match the new onPointerDown implementation; cover setPointerCapture failure branch. - Verified: vitest node+browser 537/537 pass, global coverage 100% (lines/stmts/funcs/branches), prettier + tsc + eslint clean.
Insert a bilingual 'Sample code' / '示例代码' section after Key features and before Usage notes in all 66 introduce markdown files (33 stories x en-US/zh-CN). Each sample shows the most typical usage backed by real source API, kept concise (10-32 lines).
…ecks - Update useMovable story examples to reflect simplified hook usage - Add guard checks for theme and language globals in Storybook preview
- Add 26 rows (11 names x 3 roles) and enable pagination (pageSize 10) so
multi-page selection can actually be demonstrated.
- Fix '{count}' not being interpolated: i18next default delimiters are {{ }},
but selectedCount labels used single braces {count}.
- Replace the row-based <List> of selected rows with a compact inline Space+Tag
display.
Add complete bilingual (en-US/zh-CN) Storybook stories for the utils modules introduced by the recent utils refactor: AudioPlayer, base64, color, crypto, math, stream, string. Each story includes: - index.stories.tsx with an interactive Playground demo - introduce.*.md with Overview, When to use, Key features, Sample code, Usage notes - api-doc.*.md with API tables verified against the real source exports Also register the corresponding storybook.stories.* locale keys in en-US.ts and zh-CN.ts. Verified: prettier, eslint, tsc --noEmit, storybook build all pass.
…atDrawer event names
…, and improvements
- Replace Modal maskClosable with mask.closable in ConfirmAction/DeleteConfirmAction/ModalAction stories - Replace Modal destroyOnClose with destroyOnHidden in ModalAction story - Replace Modal autoFocusButton arg/control with focusable.autoFocusButton in ConfirmAction/DeleteConfirmAction stories
|
Important Review skippedToo many files! This PR contains 254 files, which is 154 over the limit of 100. To get a review, reduce the PR to 100 files or fewer by splitting it into smaller PRs or changing its base branch. Upgrade to a paid plan to raise the limit. This review couldn't start because sufficient usage credits or metered capacity aren't available. Add credits or update usage-based reviews in the billing tab, then retry. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (254)
You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR lands a broad set of Storybook documentation and story migrations (bilingual, per-locale markdown via ?raw, antd v6 story-only adjustments) while also modularizing src/utils/* and updating a few runtime hooks/components (notably useSplitter, ModalAction, validators, and some styling tweaks).
Changes:
- Migrate Storybook docs/stories to bilingual per-locale markdown docs and localized argTypes/descriptions.
- Modularize utilities into
base64/crypto/math/color/stream/stringsubmodules with barrel exports. - Update runtime behavior in
src/(pointer interactions inuseSplitter, ModalAction destroy flags handling, validators allowing spaces, and styling adjustments).
Reviewed changes
Copilot reviewed 253 out of 253 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| test/hooks/useSplitter.test.tsx | Updates splitter tests for pointer-event entry points. |
| src/utils/string/readTextAnyEncoding.ts | Converts to default export as part of utils modularization. |
| src/utils/string/randomChars.ts | Adds randomChars utility as default export. |
| src/utils/string/index.ts | Barrels string utilities for public re-export. |
| src/utils/stream/StreamTimeSlicerClass.ts | Switches to default export while keeping types exported. |
| src/utils/stream/index.ts | Barrels stream utilities/types for public re-export. |
| src/utils/math/random.ts | Refactors random to default export (keeps overloads). |
| src/utils/math/index.ts | Barrels math utilities for public re-export. |
| src/utils/crypto/index.ts | Barrels crypto utilities for public re-export. |
| src/utils/crypto/encryptWithCryptoJS.ts | Adds CryptoJS-based AES encryption helper (dynamic imports). |
| src/utils/crypto/decryptWithCryptoJS.ts | Adds CryptoJS-based AES decryption helper (dynamic imports). |
| src/utils/crypto/advancedEncrypt.ts | Adds “advanced” encryption wrapper (noted security concern in review). |
| src/utils/crypto/advancedDecrypt.ts | Adds decrypt counterpart for advancedEncrypt. |
| src/utils/color/index.ts | Barrels color utilities for public re-export. |
| src/utils/color/getColorLuminance.ts | Converts luminance helper to default export. |
| src/utils/base64/stringToBase64.ts | Adds UTF-8 aware Base64 encoder (std + URL-safe). |
| src/utils/base64/index.ts | Barrels base64 utilities for public re-export. |
| src/utils/base64/base64ToString.ts | Adds UTF-8 aware Base64 decoder (std + URL-safe). |
| src/utils/base64/arrayBufferToBase64.ts | Adds ArrayBuffer → Base64 conversion helper. |
| src/hooks/useValidators.ts | Extends name validators to allow spaces. |
| src/hooks/useSplitter.tsx | Migrates splitter interaction to pointer events (noted event-listener mismatch in review). |
| src/hooks/useProcessingText.ts | Improves JSDoc with explicit @default annotations. |
| src/hooks/useDebounce.ts | Improves JSDoc defaults + minor formatting. |
| src/components/ModalAction/index.tsx | Adjusts destroy flag handling (destroyOnHidden vs destroyOnClose) and render defaults (noted ref-default mismatch in review). |
| src/components/Lexical/nodes/SelectNode.tsx | JSDoc default annotation alignment. |
| src/components/Lexical/nodes/base.ts | JSDoc default annotation alignment. |
| src/components/FloatDrawer/style/index.ts | Tweaks toggle positioning offsets for FloatDrawer. |
| src/components/ContextMenu/index.tsx | JSDoc default annotation alignment. |
| src/components/ConfirmAction/index.tsx | Tightens typing via satisfies ModalFuncProps and updates JSDoc defaults. |
| src/components/ConfigProvider/style/index.ts | Adds global .easy-full-height-table-v6 utility style. |
| src/components/Animation/Pulse/index.tsx | JSDoc default annotation alignment. |
| package.json | Bumps package version to 2.2.0. |
| CHANGELOG.md | Adds 2.2.0 release notes. |
| .storybook/stories/utils/string/introduce.zh-CN.md | Adds CN introduce doc for string utils. |
| .storybook/stories/utils/string/introduce.en-US.md | Adds EN introduce doc for string utils. |
| .storybook/stories/utils/string/api-doc.zh-CN.md | Adds CN API doc for string utils. |
| .storybook/stories/utils/string/api-doc.en-US.md | Adds EN API doc for string utils. |
| .storybook/stories/utils/StreamDownloader/introduce.mdx | Removes placeholder MDX introduce doc. |
| .storybook/stories/utils/StreamDownloader/introduce.en-US.md | Adds EN introduce doc for StreamDownloader. |
| .storybook/stories/utils/stream/api-doc.en-US.md | Adds EN API doc for stream utils. |
| .storybook/stories/utils/math/api-doc.zh-CN.md | Adds CN API doc for math utils. |
| .storybook/stories/utils/math/api-doc.en-US.md | Adds EN API doc for math utils. |
| .storybook/stories/utils/crypto/api-doc.zh-CN.md | Adds CN API doc for crypto utils. |
| .storybook/stories/utils/crypto/api-doc.en-US.md | Adds EN API doc for crypto utils. |
| .storybook/stories/utils/color/introduce.zh-CN.md | Adds CN introduce doc for color utils. |
| .storybook/stories/utils/color/introduce.en-US.md | Adds EN introduce doc for color utils. |
| .storybook/stories/utils/color/api-doc.zh-CN.md | Adds CN API doc for color utils. |
| .storybook/stories/utils/color/api-doc.en-US.md | Adds EN API doc for color utils. |
| .storybook/stories/utils/base64/introduce.en-US.md | Adds EN introduce doc for base64 utils. |
| .storybook/stories/shared/streamDownloaderDemo.tsx | Adjusts Alert props for story compatibility. |
| .storybook/stories/hooks/useValidators/introduce.zh-CN.md | Adds CN introduce doc for useValidators. |
| .storybook/stories/hooks/useValidators/introduce.en-US.md | Adds EN introduce doc for useValidators. |
| .storybook/stories/hooks/useValidators/api-doc.en-US.md | Adds EN API doc for useValidators. |
| .storybook/stories/hooks/useValidatorBuilder/api-doc.en-US.md | Adds EN API doc for useValidatorBuilder. |
| .storybook/stories/hooks/useValidator/introduce.zh-CN.md | Adds CN introduce doc for useValidator. |
| .storybook/stories/hooks/useValidator/introduce.en-US.md | Adds EN introduce doc for useValidator. |
| .storybook/stories/hooks/useValidator/api-doc.zh-CN.md | Adds CN API doc for useValidator. |
| .storybook/stories/hooks/useValidator/api-doc.en-US.md | Adds EN API doc for useValidator. |
| .storybook/stories/hooks/useUserMedia/introduce.en-US.md | Adds EN introduce doc for useUserMedia. |
| .storybook/stories/hooks/useUserMedia/api-doc.zh-CN.md | Adds CN API doc for useUserMedia. |
| .storybook/stories/hooks/useUserMedia/api-doc.en-US.md | Adds EN API doc for useUserMedia. |
| .storybook/stories/hooks/useStreamDownloader/api-doc.zh-CN.md | Adds CN API doc for useStreamDownloader. |
| .storybook/stories/hooks/useStreamDownloader/api-doc.en-US.md | Adds EN API doc for useStreamDownloader. |
| .storybook/stories/hooks/useStompSocket/introduce.zh-CN.md | Adds CN introduce doc for useStompSocket. |
| .storybook/stories/hooks/useStompSocket/introduce.en-US.md | Adds EN introduce doc for useStompSocket. |
| .storybook/stories/hooks/useStompSocket/api-doc.zh-CN.md | Adds CN API doc for useStompSocket. |
| .storybook/stories/hooks/useStompSocket/api-doc.en-US.md | Adds EN API doc for useStompSocket. |
| .storybook/stories/hooks/useSSE/api-doc.zh-CN.md | Adds CN API doc for useSSE. |
| .storybook/stories/hooks/useSSE/api-doc.en-US.md | Adds EN API doc for useSSE. |
| .storybook/stories/hooks/useSplitter/introduce.en-US.md | Adds EN introduce doc for useSplitter. |
| .storybook/stories/hooks/useSplitter/api-doc.zh-CN.md | Adds CN API doc for useSplitter. |
| .storybook/stories/hooks/useSplitter/api-doc.en-US.md | Adds EN API doc for useSplitter. |
| .storybook/stories/hooks/useRowSelection/introduce.zh-CN.md | Adds CN introduce doc for useRowSelection. |
| .storybook/stories/hooks/useRowSelection/introduce.en-US.md | Adds EN introduce doc for useRowSelection. |
| .storybook/stories/hooks/useRowSelection/api-doc.zh-CN.md | Adds CN API doc for useRowSelection. |
| .storybook/stories/hooks/useRowSelection/api-doc.en-US.md | Adds EN API doc for useRowSelection. |
| .storybook/stories/hooks/useRefValue/introduce.zh-CN.md | Adds CN introduce doc for useRefValue. |
| .storybook/stories/hooks/useRefValue/introduce.en-US.md | Adds EN introduce doc for useRefValue. |
| .storybook/stories/hooks/useRefValue/api-doc.zh-CN.md | Adds CN API doc for useRefValue. |
| .storybook/stories/hooks/useRefValue/api-doc.en-US.md | Adds EN API doc for useRefValue. |
| .storybook/stories/hooks/useRefFunction/introduce.zh-CN.md | Adds CN introduce doc for useRefFunction. |
| .storybook/stories/hooks/useRefFunction/introduce.en-US.md | Adds EN introduce doc for useRefFunction. |
| .storybook/stories/hooks/useRefFunction/api-doc.zh-CN.md | Adds CN API doc for useRefFunction. |
| .storybook/stories/hooks/useRefFunction/api-doc.en-US.md | Adds EN API doc for useRefFunction. |
| .storybook/stories/hooks/useProcessingText/introduce.zh-CN.md | Adds CN introduce doc for useProcessingText. |
| .storybook/stories/hooks/useProcessingText/introduce.en-US.md | Adds EN introduce doc for useProcessingText. |
| .storybook/stories/hooks/useProcessingText/api-doc.zh-CN.md | Adds CN API doc for useProcessingText. |
| .storybook/stories/hooks/useProcessingText/api-doc.en-US.md | Adds EN API doc for useProcessingText. |
| .storybook/stories/hooks/useMovable/introduce.zh-CN.md | Adds CN introduce doc for useMovable. |
| .storybook/stories/hooks/useMovable/introduce.en-US.md | Adds EN introduce doc for useMovable. |
| .storybook/stories/hooks/useMovable/api-doc.zh-CN.md | Adds CN API doc for useMovable. |
| .storybook/stories/hooks/useMovable/api-doc.en-US.md | Adds EN API doc for useMovable. |
| .storybook/stories/hooks/useLocalStorage/introduce.zh-CN.md | Adds CN introduce doc for useLocalStorage. |
| .storybook/stories/hooks/useLocalStorage/introduce.en-US.md | Adds EN introduce doc for useLocalStorage. |
| .storybook/stories/hooks/useLocalStorage/api-doc.zh-CN.md | Adds CN API doc for useLocalStorage. |
| .storybook/stories/hooks/useLocalStorage/api-doc.en-US.md | Adds EN API doc for useLocalStorage. |
| .storybook/stories/hooks/useDebounce/introduce.en-US.md | Adds EN introduce doc for useDebounce. |
| .storybook/stories/hooks/useDebounce/api-doc.zh-CN.md | Adds CN API doc for useDebounce. |
| .storybook/stories/hooks/useDebounce/api-doc.en-US.md | Adds EN API doc for useDebounce. |
| .storybook/stories/components/VirtualTextViewer/introduce.zh-CN.md | Adds CN introduce doc for VirtualTextViewer. |
| .storybook/stories/components/VirtualTextViewer/introduce.en-US.md | Adds EN introduce doc for VirtualTextViewer. |
| .storybook/stories/components/VirtualTextViewer/index.stories.tsx | Migrates story to ?raw markdown docs + new locales wiring. |
| .storybook/stories/components/VirtualTextViewer/api-doc.zh-CN.md | Adds CN API doc for VirtualTextViewer. |
| .storybook/stories/components/VirtualTextViewer/api-doc.en-US.md | Adds EN API doc for VirtualTextViewer. |
| .storybook/stories/components/PulseAnimation/introduce.zh-CN.md | Adds CN introduce doc for PulseAnimation. |
| .storybook/stories/components/PulseAnimation/introduce.en-US.md | Adds EN introduce doc for PulseAnimation. |
| .storybook/stories/components/PulseAnimation/api-doc.zh-CN.md | Adds CN API doc for PulseAnimation. |
| .storybook/stories/components/PulseAnimation/api-doc.en-US.md | Adds EN API doc for PulseAnimation. |
| .storybook/stories/components/OverflowTags/introduce.zh-CN.md | Adds CN introduce doc for OverflowTags. |
| .storybook/stories/components/OverflowTags/introduce.en-US.md | Adds EN introduce doc for OverflowTags. |
| .storybook/stories/components/OverflowTags/index.stories.tsx | Migrates story to ?raw markdown docs + localized argTypes. |
| .storybook/stories/components/OverflowTags/api-doc.zh-CN.md | Adds CN API doc for OverflowTags. |
| .storybook/stories/components/OverflowTags/api-doc.en-US.md | Adds EN API doc for OverflowTags. |
| .storybook/stories/components/ModalAction/api-doc.zh-CN.md | Adds CN API doc for ModalAction. |
| .storybook/stories/components/ModalAction/api-doc.en-US.md | Adds EN API doc for ModalAction. |
| .storybook/stories/components/Loading/introduce.zh-CN.md | Adds CN introduce doc for Loading. |
| .storybook/stories/components/Loading/introduce.en-US.md | Adds EN introduce doc for Loading. |
| .storybook/stories/components/Loading/index.stories.tsx | Migrates story to ?raw markdown docs wiring. |
| .storybook/stories/components/Loading/api-doc.zh-CN.md | Adds CN API doc for Loading. |
| .storybook/stories/components/Loading/api-doc.en-US.md | Adds EN API doc for Loading. |
| .storybook/stories/components/Iconfont/introduce.zh-CN.md | Adds CN introduce doc for Iconfont. |
| .storybook/stories/components/Iconfont/introduce.md | Removes old combined bilingual introduce doc. |
| .storybook/stories/components/Iconfont/introduce.en-US.md | Adds EN introduce doc for Iconfont. |
| .storybook/stories/components/Iconfont/api-doc.zh-CN.md | Adds CN API doc for Iconfont. |
| .storybook/stories/components/Iconfont/api-doc.md | Removes old combined bilingual API doc. |
| .storybook/stories/components/Iconfont/api-doc.en-US.md | Adds EN API doc for Iconfont. |
| .storybook/stories/components/FormItemControl/introduce.zh-CN.md | Adds CN introduce doc for FormItemControl. |
| .storybook/stories/components/FormItemControl/introduce.en-US.md | Adds EN introduce doc for FormItemControl. |
| .storybook/stories/components/FormItemControl/index.stories.tsx | Migrates story to ?raw markdown docs wiring. |
| .storybook/stories/components/FormItemControl/api-doc.zh-CN.md | Adds CN API doc for FormItemControl. |
| .storybook/stories/components/FormItemControl/api-doc.en-US.md | Adds EN API doc for FormItemControl. |
| .storybook/stories/components/FloatDrawer/introduce.zh-CN.md | Adds CN introduce doc for FloatDrawer. |
| .storybook/stories/components/FloatDrawer/introduce.en-US.md | Adds EN introduce doc for FloatDrawer. |
| .storybook/stories/components/FloatDrawer/index.stories.tsx | Migrates story to ?raw markdown docs wiring. |
| .storybook/stories/components/FloatDrawer/api-doc.zh-CN.md | Adds CN API doc for FloatDrawer. |
| .storybook/stories/components/FloatDrawer/api-doc.en-US.md | Adds EN API doc for FloatDrawer. |
| .storybook/stories/components/EllipsisTypography/introduce.zh-CN.md | Adds CN introduce doc for EllipsisTypography. |
| .storybook/stories/components/EllipsisTypography/introduce.en-US.md | Adds EN introduce doc for EllipsisTypography. |
| .storybook/stories/components/EllipsisTypography/api-doc.zh-CN.md | Adds CN API doc for EllipsisTypography. |
| .storybook/stories/components/EllipsisTypography/api-doc.en-US.md | Adds EN API doc for EllipsisTypography. |
| .storybook/stories/components/EditableText/introduce.zh-CN.md | Adds CN introduce doc for EditableText. |
| .storybook/stories/components/EditableText/introduce.en-US.md | Adds EN introduce doc for EditableText. |
| .storybook/stories/components/EditableText/api-doc.zh-CN.md | Adds CN API doc for EditableText. |
| .storybook/stories/components/EditableText/api-doc.en-US.md | Adds EN API doc for EditableText. |
| .storybook/stories/components/DeleteConfirmAction/introduce.zh-CN.md | Adds CN introduce doc for DeleteConfirmAction. |
| .storybook/stories/components/DeleteConfirmAction/introduce.en-US.md | Adds EN introduce doc for DeleteConfirmAction. |
| .storybook/stories/components/DeleteConfirmAction/api-doc.zh-CN.md | Adds CN API doc for DeleteConfirmAction. |
| .storybook/stories/components/DeleteConfirmAction/api-doc.en-US.md | Adds EN API doc for DeleteConfirmAction. |
| .storybook/stories/components/ContextMenu/introduce.en-US.md | Adds EN introduce doc for ContextMenu. |
| .storybook/stories/components/ContextMenu/index.stories.tsx | Migrates story to ?raw markdown docs wiring. |
| .storybook/stories/components/ContextMenu/api-doc.zh-CN.md | Adds CN API doc for ContextMenu. |
| .storybook/stories/components/ContextMenu/api-doc.en-US.md | Adds EN API doc for ContextMenu. |
| .storybook/stories/components/ConfirmAction/api-doc.en-US.md | Adds EN API doc for ConfirmAction. |
| .storybook/stories/components/ConfigProvider/introduce.zh-CN.md | Adds CN introduce doc for ConfigProvider. |
| .storybook/stories/components/ConfigProvider/introduce.en-US.md | Adds EN introduce doc for ConfigProvider. |
| .storybook/stories/components/ConfigProvider/index.stories.tsx | Migrates story to ?raw markdown docs wiring + Space prop update. |
| .storybook/stories/components/ConfigProvider/api-doc.zh-CN.md | Adds CN API doc for ConfigProvider. |
| .storybook/stories/components/ConfigProvider/api-doc.en-US.md | Adds EN API doc for ConfigProvider. |
| .storybook/stories/components/ColumnSetting/introduce.en-US.md | Adds EN introduce doc for ColumnSetting. |
| .storybook/stories/components/ColumnSetting/index.stories.tsx | Migrates story to ?raw markdown docs wiring + import path updates. |
| .storybook/stories/components/ColumnSetting/api-doc.zh-CN.md | Adds CN API doc for ColumnSetting. |
| .storybook/stories/components/ColumnSetting/api-doc.en-US.md | Adds EN API doc for ColumnSetting. |
| .storybook/stories/components/BreakLines/introduce.zh-CN.md | Adds CN introduce doc for BreakLines. |
| .storybook/stories/components/BreakLines/introduce.en-US.md | Adds EN introduce doc for BreakLines. |
| .storybook/stories/components/BreakLines/index.stories.tsx | Adds new story file with ?raw markdown docs wiring. |
| .storybook/stories/components/BreakLines/api-doc.zh-CN.md | Adds CN API doc for BreakLines. |
| .storybook/stories/components/BreakLines/api-doc.en-US.md | Adds EN API doc for BreakLines. |
| .storybook/stories/components/BreakLines.stories.tsx | Removes old story file in favor of new structure. |
| .storybook/preview-head.html | Adds docs wrapper padding adjustments. |
| const formRef = useRefValue(form); | ||
| const onBeforeOpenRef = useRefValue(onBeforeOpen); | ||
| const destroyOnCloseRef = useRefValue(destroyOnClose || destroyOnHidden); | ||
| const destroyOnCloseRef = useRefValue(destroyOnHidden ?? destroyOnClose); |
Comment on lines
+1
to
+4
| import { stringToBase64 } from '../base64'; | ||
| import { random } from '../math'; | ||
| import { randomChars } from '../string'; | ||
| import encryptAES from './encryptAES'; |
Comment on lines
+202
to
+211
| onPointerDown={(e) => { | ||
| try { | ||
| splitterRef?.setPointerCapture?.(e.pointerId); | ||
| } catch { | ||
| // do nothing | ||
| } | ||
| setDragging(true); | ||
| }} | ||
| onPointerEnter={() => setIsOver(true)} | ||
| onPointerLeave={() => setIsOver(false)} |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR brings the
feature/component-docsbranch tomaster. It contains 33 commits covering Storybook bilingual documentation, antd v5 → v6 migration for stories, utils modularization, useMovable viewport support, and ModalAction destroyOnClose logic fixes.Highlights
Storybook / Documentation
.storybook/stories/**/introduce.*.md,api-doc.*.md) with?rawimportsstoryTlocalizationrandom()as a secureMath.random()replacement in utils/math docsantd v6 migration (Storybook only)
ConfirmAction,DeleteConfirmAction,ModalAction):maskClosable→mask: { closable }destroyOnClose→destroyOnHiddenautoFocusButton→focusable.autoFocusButton.storybook/, nosrc/changesUtils & Components
base64,color,crypto,math,stream,string)easy-full-height-table-v6CSS utilityuseMovablehook with viewport support andonMovecallbackBug fixes
fix(ModalAction): improve destroyOnClose logic— preferdestroyOnHiddenwith fallback todestroyOnClosefix(ModalAction): ensure default values for destroyOnClose and destroyOnHidden props— restore defaults at render site (?? true), keeping the fallback branch reachableTests
useMovable/useSplittertests for viewport/enhanced APIsVerification
npx vitest run --coverage— 100% on all four thresholds (statements/branches/functions/lines)npx tsc -p tsconfig.json --noEmit— cleannpx storybook build— succeedsCommits
33 commits ahead of
master(origin/master..HEAD), including:ca93b0bfix(ModalAction): ensure default values for destroyOnClose and destroyOnHidden propsd916cb4fix(ModalAction): improve destroyOnClose logic184dd83fix(storybook): migrate antd v5 deprecated props to v6 APIs8982601test(FloatDrawer): replace mouse events with pointer events in dragResize tests3a63ed9docs: update changelog for version 2.2.0cc1574cfeat(utils): split utils into modular implementations, and change FloatDrawer event namesRisks / Notes
.storybook/files (docs-only, no runtime impact)src/changes are limited toModalAction,useMovable,FloatDrawer, utils modularization, and CSS utility