docs(configurator): add configurator docs #631
Conversation
WalkthroughThis update introduces comprehensive documentation for various configurator components within the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
gene9831
changed the title
gene9831
changed the title
gene9831
changed the title
![coderabbitai[bot]](https://github.com/avatars/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (7)
packages/configurator/docs/CodeConfigurator.pngis excluded by!**/*.pngpackages/configurator/docs/CodeConfiguratorDialog.pngis excluded by!**/*.pngpackages/configurator/docs/CollectionConfigurator.pngis excluded by!**/*.pngpackages/configurator/docs/ColorConfigurator.pngis excluded by!**/*.pngpackages/configurator/docs/InputConfigurator.pngis excluded by!**/*.pngpackages/configurator/docs/SelectConfigurator.pngis excluded by!**/*.pngpackages/configurator/docs/SwitchConfigurator.pngis excluded by!**/*.png
Files selected for processing (6)
- packages/configurator/docs/CodeConfigurator.md (1 hunks)
- packages/configurator/docs/CollectionConfigurator.md (1 hunks)
- packages/configurator/docs/ColorConfigurator.md (1 hunks)
- packages/configurator/docs/InputConfigurator.md (1 hunks)
- packages/configurator/docs/SelectConfigurator.md (1 hunks)
- packages/configurator/docs/SwitchConfigurator.md (1 hunks)
Files skipped from review due to trivial changes (5)
- packages/configurator/docs/CodeConfigurator.md
- packages/configurator/docs/CollectionConfigurator.md
- packages/configurator/docs/ColorConfigurator.md
- packages/configurator/docs/SelectConfigurator.md
- packages/configurator/docs/SwitchConfigurator.md
Additional context used
LanguageTool
packages/configurator/docs/InputConfigurator.md
[uncategorized] ~29-~29: A punctuation mark might be missing here.
Context: ... |"Array"| -- | 当值为"Array"时，会将输入框的值使用英文逗号分割，然后将属性的值设置成数组 | | rows |number...(AI_EN_LECTOR_MISSING_PUNCTUATION)
Additional comments not posted (3)
packages/configurator/docs/InputConfigurator.md (3)
3-5: LGTM!The introduction is clear and concise.
7-9: LGTM!The display example is straightforward and includes a relevant image.
11-21: LGTM!The configuration example is clear and well-structured.
…to docs/configurator-docs
gene9831
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (8)
packages/configurator/docs/HtmlAttributesConfigurator.pngis excluded by!**/*.pngpackages/configurator/docs/HtmlTextConfigurator.pngis excluded by!**/*.pngpackages/configurator/docs/JsSlotConfigurator.pngis excluded by!**/*.pngpackages/configurator/docs/LayoutGridConfigurator.pngis excluded by!**/*.pngpackages/configurator/docs/NumberConfigurator.pngis excluded by!**/*.pngpackages/configurator/docs/RadioGroupConfigurator.pngis excluded by!**/*.pngpackages/configurator/docs/SelectIconConfigurator.pngis excluded by!**/*.pngpackages/configurator/docs/VariableConfigurator.pngis excluded by!**/*.png
Files selected for processing (8)
- packages/configurator/docs/HtmlAttributesConfigurator.md (1 hunks)
- packages/configurator/docs/HtmlTextConfigurator.md (1 hunks)
- packages/configurator/docs/JsSlotConfigurator.md (1 hunks)
- packages/configurator/docs/LayoutGridConfigurator.md (1 hunks)
- packages/configurator/docs/NumberConfigurator.md (1 hunks)
- packages/configurator/docs/RadioGroupConfigurator.md (1 hunks)
- packages/configurator/docs/SelectIconConfigurator.md (1 hunks)
- packages/configurator/docs/VariableConfigurator.md (1 hunks)
Files skipped from review due to trivial changes (6)
- packages/configurator/docs/HtmlAttributesConfigurator.md
- packages/configurator/docs/HtmlTextConfigurator.md
- packages/configurator/docs/JsSlotConfigurator.md
- packages/configurator/docs/LayoutGridConfigurator.md
- packages/configurator/docs/SelectIconConfigurator.md
- packages/configurator/docs/VariableConfigurator.md
Additional context used
LanguageTool
packages/configurator/docs/RadioGroupConfigurator.md
[typographical] ~31-~31: Unpaired symbol: ‘'’ seems to be missing
Context: ... |'radio| 单选组展示形式 |(EN_UNPAIRED_QUOTES)
packages/configurator/docs/NumberConfigurator.md
[locale-violation] ~34-~34: Possible error ortogràfic. Aquesta forma verbal no es correspon amb la varietat seleccionada (central).
Context: ...oolean|false` ...(EXIGEIX_VERBS_CENTRAL)
[typographical] ~35-~35: Símbol sense parella: sembla que falta «{».
Context: ...rray<{value: string, label: string}>|[{ value: 'px', label: 'px' },{ value: '%', label: '%' }]` | 单位列表，可以通过选择器选择单位 ...(UNPAIRED_BRACKETS)
[locale-violation] ~38-~38: Possible error ortogràfic. Aquesta forma verbal no es correspon amb la varietat seleccionada (central).
Context: ...oolean|false` ...(EXIGEIX_VERBS_CENTRAL)
Additional comments not posted (7)
packages/configurator/docs/RadioGroupConfigurator.md (4)
3-5: LGTM!The introduction is concise and clear.
7-9: LGTM!The display section is straightforward and includes a relevant image.
11-23: LGTM!The configuration example is correctly formatted and includes relevant properties.
26-31: Fix the unpaired symbol in thetyperow.There is an unpaired symbol (
') in thetyperow.- | type | `'radio' \| 'button'` | `'radio` | 单选组展示形式 | + | type | `'radio' \| 'button'` | `'radio' | 单选组展示形式 |Likely invalid or redundant comment.
Tools
LanguageTool
[typographical] ~31-~31: Unpaired symbol: ‘'’ seems to be missing
Context: ... |'radio| 单选组展示形式 |(EN_UNPAIRED_QUOTES)
packages/configurator/docs/NumberConfigurator.md (3)
3-5: LGTM!The introduction is concise and clear.
7-9: LGTM!The display section is straightforward and includes a relevant image.
11-23: LGTM!The configuration example is correctly formatted and includes relevant properties.
English | 简体中文
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
Background and solution
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit
CollectionConfigurator,ColorConfigurator,SelectConfigurator,SwitchConfigurator,HtmlAttributesConfigurator,HtmlTextConfigurator,JsSlotConfigurator,NumberConfigurator,SelectIconConfigurator.CodeConfigurator,InputConfigurator,LayoutGridConfigurator,RadioGroupConfigurator,VariableConfigurator.These changes provide detailed examples, configuration options, and properties to aid users in utilizing various configurator components effectively.