rename UI components #75
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -159,22 +159,31 @@ This modal is based on [svelte-modals](https://svelte-modals.mattjennings.io/) w | |||||||||||||||||||||||
| 🌙 | ||||||||||||||||||||||||
| ## MoonBase components | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| Renderer: Takes JSON definitions and based on the type property shows a specific widget (e.g. input, checkbox, dropdown, ...) | ||||||||||||||||||||||||
| Widget: Complex, interactive components with editing capabilities | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| <img width="30" src="https://github.com/user-attachments/assets/b0e8af99-ed76-422a-8bd1-bfbd9e0f4c44"/> | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| ### FieldRenderer | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| Support for html input widgets including text, number, range, checkbox and pad (multiple buttons in 2D array layout) | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| ### RowRenderer | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| * Show multiple rows of objects | ||||||||||||||||||||||||
| * Summary and zoom | ||||||||||||||||||||||||
| * Recursive | ||||||||||||||||||||||||
| * A row renderer can have a row renderer e.g. multiple nodes with multiple controls per node | ||||||||||||||||||||||||
|
Comment on lines
+174
to
+176
There was a problem hiding this comment. Fix list indentation to match markdown standards. The unordered list items under RowRenderer are indented with 4 spaces when they should use 2 spaces per markdown formatting rules. ### RowRenderer
-* Show multiple rows of objects
- * Summary and zoom
+* Show multiple rows of objects
+ * Summary and zoom
* Recursive
- * A row renderer can have a row renderer e.g. multiple nodes with multiple controls per node
+ * A row renderer can have a row renderer e.g. multiple nodes with multiple controls per node📝 Committable suggestion
Suggested change
🧰 Tools🪛 markdownlint-cli2 (0.18.1)174-174: Unordered list indentation (MD007, ul-indent) 176-176: Unordered list indentation (MD007, ul-indent) 🤖 Prompt for AI Agents
Collaborator
Author
There was a problem hiding this comment. @coderabbitai, regarding
If I indent with 2 spaces it doesn't look good, I need 4 to show it the right way indented. Can you check why that is and confirm about the standard: 2, 3 or 4 spaces? There was a problem hiding this comment. 🧩 Analysis chain🌐 Web query: 💡 Result: Short answer: Neither CommonMark nor GitHub require a fixed 2‑ or 4‑space rule. Instead they use the column of the first non‑whitespace character after the list marker as the “baseline” for that list item, and continuation / nested blocks must be indented to at least that column. That means 2 spaces will work in many common cases, but other cases (ordered lists with wider markers, or extra spaces after the marker) require 3, 4, 5, etc. spaces. [1][2][3] Examples and references:
Sources: If you want, I can show minimal examples that illustrate when 2 spaces works and when more are needed. Citations:
@ewowi, you're right to question this! The CommonMark and GitHub Flavored Markdown specifications don't actually mandate a fixed 2 or 4 space rule. Instead, they use the column of the first non-whitespace character after the list marker as the baseline, and nested blocks must be indented to at least that column. In practice, this means:
The markdownlint tool's MD007 rule is being prescriptive with its default configuration (expecting 2 spaces), but if 4 spaces renders correctly in your documentation viewer and looks better, then it's perfectly valid. My recommendation: Since the content renders properly with 4 spaces and that's what looks good in your documentation, you have two options:
The standard is flexible by design, so trust what renders correctly in your documentation viewer over the linter's default preference. 👍 |
||||||||||||||||||||||||
| * Uses FieldRenderer | ||||||||||||||||||||||||
| * Used data and definition rest apis | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| ### EditRowWidget | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| Shows all fields of a row (using FieldRenderer) in a popup | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| ### FileEditWidget | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| Shows filename, file contents and uploadfile (from file system). Used in FileManager and FieldRenderer (select widgets containing files, which can directly be edited - for livescripts) | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| Arguments | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add alt text to the image for accessibility.
The image on line 165 is missing alt text, which is required for accessibility compliance.
📝 Committable suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
165-165: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents