docs(dialog): add an option field to the form example

[adrianschmidt]

This helps us test limel-select when used in a limel-form inside a limel-dialog.

Summary by CodeRabbit

• New Features
  • Enhanced the form by introducing a favorite color selection, allowing users to choose from a predefined set of options.
  • Updated the submission confirmation to display the selected favorite color along with other form details.

Review:

• Commits are atomic
• Commits have the correct type for the changes made
• Commits with breaking changes are marked as such

Browsers tested:

(Check any that applies, it's ok to leave boxes unchecked if testing something didn't seem relevant.)

Windows:

• Chrome
• Edge
• Firefox

Linux:

• Chrome
• Firefox

macOS:

• Chrome
• Firefox
• Safari

Mobile:

• Chrome on Android
• iOS

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a new property, color, to the dialog form component. This property is added to the FormValue interface and initialized in the component’s state with the default value 'red'. The form schema is updated with a new definition for color, including a title ("Favorite color") and predefined options (red, yellow, green, blue, black). Additionally, the submission logic is modified so that the alert message now includes the favorite color along with the user's name and age.

Changes

File	Change Summary
src/…/dialog-form.tsx	- Added color: string to the FormValue interface. - Initialized color to 'red' in the form state. - Updated formSchema with a color property (type: string, title: "Favorite color", with color options). - Modified submitForm to include the color in the alert message.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant D as DialogForm
    participant A as Alert

    U->>D: Enter name, age, select favorite color
    D->>D: Update form state (including color)
    U->>D: Click submit
    D->>D: Prepare alert message with name, age, and color
    D->>A: Display alert message

Loading

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f556c7a and 74dc73f.

📒 Files selected for processing (1)

• src/components/dialog/examples/dialog-form.tsx (4 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

`**/*.tsx`: Our `.tsx` files are typically using StencilJS, not React.

**/*.tsx: Our .tsx files are typically using StencilJS, not React.

• src/components/dialog/examples/dialog-form.tsx

`**/*.{ts,tsx}`: Imports from other files in the same module (lime-elements) must use relative paths. Using absolute paths for imports will cause the production build to fail.

**/*.{ts,tsx}: Imports from other files in the same module (lime-elements) must use relative paths. Using absolute paths for imports will cause the production build to fail.

• src/components/dialog/examples/dialog-form.tsx

`src/components/**/examples/**/*.{ts,tsx}`: These files are an exception to the rule that all imports should use relative paths. When these example files import something that is p...

src/components/**/examples/**/*.{ts,tsx}: These files are an exception to the rule that all imports should use relative paths. When these example files import something that is publically exported by lime-elements, the import should be made from @limetech/lime-elements. If they import something from another file inside the example folder, the import should use a relative path.

• src/components/dialog/examples/dialog-form.tsx

🔇 Additional comments (4)

src/components/dialog/examples/dialog-form.tsx (4)

16-16: LGTM: Added color property to FormValue interface

The addition of the color string property to the FormValue interface correctly types the new form field.

---

43-43: LGTM: Property initialization

The color property is properly initialized with the value 'red', which matches one of the predefined options in the schema.

---

86-116: LGTM: Well-structured schema definition for color selection

The schema definition for the color property is well-structured, with appropriate type, title, and predefined options. The use of oneOf correctly implements a dropdown selection with human-readable titles for each color option.

---

185-187: LGTM: Updated alert message to include color

The alert message now correctly includes the favorite color, using proper optional chaining for all properties.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Copilot]

Pull Request Overview

This PR updates the dialog form example by adding an option field for selecting a color, which helps test the limel-select component integration within a limel-form inside a limel-dialog.

• Added a new "color" field to the form interface and its default value.
• Updated the JSON schema with a "color" property and a list of allowed color options.
• Extended the submit alert to include the selected favorite color.

Comments suppressed due to low confidence (1)

src/components/dialog/examples/dialog-form.tsx:185

• Consider adding a test case to verify that the alert message correctly displays the favorite color value when the form is submitted.

alert(

[github-actions]

Documentation has been published to https://lundalogik.github.io/lime-elements/versions/PR-3513/