Feat/settings navigation button

[ghost]

Description of change

Built Settings Navigation Button
with trailing icon

without trailing icon

Issue Number

closes #139

Type of change

• New (a change which implements a new feature)
• Update (a change which updates existing functionality)

How the change has been tested

CI and Manual

Change checklist

• I have ensured that the CI Checks pass locally
• I have removed any unnecessary logic
• My code is well documented
• I have signed my commits
• My code follows the pattern of the application
• I have self reviewed my code

Summary by CodeRabbit

• New Features
  • Introduced a new Settings Navigation Button component with customizable icon, text, and optional trailing arrow.
  • Added interactive Storybook stories showcasing primary and secondary button variants with click actions.
  • Provided reusable UI snippets for button text and icon to enhance consistency and flexibility.

[coderabbitai]

Warning

Rate limit exceeded

@pixel-punk-20 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 53 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between b36b412 and 22942a0.

📒 Files selected for processing (2)

• platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.stories.ts (1 hunks)
• platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.svelte (1 hunks)

"""

Walkthrough

A new SettingsNavigationButton Svelte component was introduced, along with its Storybook story, snippet definitions for button text and icon, and an export in the fragments index. The button supports a leading icon as a snippet, a children snippet for content, and a click handler, and is styled with flexbox and Hugeicons icons.

Changes

File(s)	Change Summary
platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.svelte	New Svelte component for a settings navigation button with props for leading icon, children content, and click handler.
platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.stories.ts	New Storybook story file for the button, with a primary story using snippet-based children and icon, and a click handler.
platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.stories.snippet.svelte	New snippet file exporting ButtonText and ButtonIcon for use in stories and as UI fragments.
platforms/metagram/src/lib/fragments/index.ts	Added export for SettingsNavigationButton in the fragments index.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SettingsNavigationButton
    participant Snippet (Icon/Text)

    User->>SettingsNavigationButton: Clicks button
    SettingsNavigationButton->>Snippet (Icon/Text): Renders leadingIcon and children
    SettingsNavigationButton->>User: Triggers handleClick callback

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Button for settings navigation with snippet-based icon and callback handler (#139)	✅
Trailing icon (right arrow) present as per reference (#139)	✅
Leading icon is a snippet, callback handler is present (#139)	✅
Button content is snippet-based, matches desired output structure (#139)	✅

Suggested reviewers

• coodos
• sosweetham

Poem

A button for settings, so shiny and neat,
With snippets for icons and text to greet.
Click it, it listens, and arrows appear—
Navigation made simple, intentions so clear!
🐇✨
"""

✨ 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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (5)

platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.stories.snippet.svelte (1)

8-10: Consider more descriptive button text.

The current button text "Settings Button" is generic. Consider using text that better describes the specific settings area this button navigates to.

platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.stories.ts (1)

18-20: Consider adding more story variants.

Currently, only a Primary variant is defined. Consider adding additional variants to showcase the button without a leading icon, or with different styling options.

For example:

export const WithoutIcon = {
  args: { children: ButtonText, handleClick: () => alert('clicked without icon') }
};

export const CustomStyling = {
  args: { 
    children: ButtonText, 
    leadingIcon: ButtonIcon, 
    handleClick: () => alert('clicked'), 
    class: 'bg-gray-100 rounded-lg'
  }
};

platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.svelte (3)

8-12: Fix typo in interface name.

There's a typo in the interface name ISettingsNaviationButtonProps (missing 'g' in 'Navigation').

-interface ISettingsNaviationButtonProps extends HTMLButtonAttributes {
+interface ISettingsNavigationButtonProps extends HTMLButtonAttributes {

---

14-15: Update variable type after fixing interface name.

If you fix the interface name, update this variable type as well.

-let { leadingIcon, children, handleClick, ...restProps }: ISettingsNaviationButtonProps =
+let { leadingIcon, children, handleClick, ...restProps }: ISettingsNavigationButtonProps =

---

29-31: Consider using a more semantic element.

Using an h3 for button content might not be semantically appropriate if this is navigation rather than a section heading. Consider using a span with appropriate styling instead.

-<h3 class="text-black-800 font-semibold">
+<span class="text-black-800 font-semibold">
   {@render children?.()}
-</h3>
+</span>

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 941ad7b and 957a174.

📒 Files selected for processing (4)

• platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.stories.snippet.svelte (1 hunks)
• platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.stories.ts (1 hunks)
• platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.svelte (1 hunks)
• platforms/metagram/src/lib/fragments/index.ts (1 hunks)

🔇 Additional comments (6)

platforms/metagram/src/lib/fragments/index.ts (1)

1-1: Export statement looks good.

The export statement correctly makes the new SettingsNavigationButton component available for import elsewhere in the application.

platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.stories.snippet.svelte (2)

1-6: Import and export declarations look correct.

The import statements correctly bring in the necessary Hugeicons components, and the export statement properly exposes the defined snippets.

---

12-14: Icon implementation looks good.

The ButtonIcon snippet correctly implements the HugeiconsIcon with appropriate size and color using CSS variables for consistent theming.

platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.stories.ts (1)

1-16: Storybook configuration is well-structured.

The story configuration follows best practices with proper typing, autodocs tag, and a clean render function.

platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.svelte (2)

23-27: Ensure consistent color tokens use.

The class bg-brand-burnt-orange-100 suggests using a design system color token. Verify this is the correct token for the background of the icon container. Also, consider extracting this styling to a constant like you did with cBase for better maintainability.

---

20-20: 🛠️ Refactor suggestion

Use 'on:click' instead of 'onclick'.

In Svelte, the recommended event binding syntax is 'on:click' rather than 'onclick'.

-<button {...restProps} class={cn([cBase, restProps.class].join(' '))} onclick={handleClick}>
+<button {...restProps} class={cn([cBase, restProps.class].join(' '))} on:click={handleClick}>

⛔ Skipped due to learnings

Learnt from: pixel-punk-20
PR: MetaState-Prototype-Project/prototype#121
File: platforms/metagram/src/lib/ui/Button/Button.svelte:83-83
Timestamp: 2025-05-08T08:40:51.710Z
Learning: In Svelte 5, event handlers should use lowercase DOM-style attributes (e.g., `onclick={handler}`) rather than the Svelte 3/4 syntax with the `on:` prefix (e.g., `on:click={handler}`). The `on:` syntax is deprecated in Svelte 5 though still supported for backward compatibility.

Learnt from: pixel-punk-20
PR: MetaState-Prototype-Project/prototype#121
File: platforms/metagram/src/lib/ui/Button/Button.svelte:83-83
Timestamp: 2025-05-08T08:40:51.710Z
Learning: In Svelte 5, event handlers can be written using the lowercase DOM-style attributes (e.g., `onclick`) rather than the Svelte 3/4 syntax with the `on:` prefix (e.g., `on:click`). Both syntaxes are supported, but `onclick` is the newer approach introduced in Svelte 5.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.stories.ts (1)

18-20: Consider using Storybook actions for click handlers.

While alerts work for demonstration purposes, Storybook's actions would provide a better developer experience.

+import { action } from '@storybook/addon-actions';

 export const Primary = {
-	args: { children: ButtonText, leadingIcon: ButtonIcon, handleClick: () => alert('clicked'), isTrailingIcon: true }
+	args: { children: ButtonText, leadingIcon: ButtonIcon, handleClick: action('button-clicked'), isTrailingIcon: true }
 };

 export const Secondary = {
-	args: { children: ButtonText, leadingIcon: ButtonIcon, handleClick: () => alert('clicked'), isTrailingIcon: false }
+	args: { children: ButtonText, leadingIcon: ButtonIcon, handleClick: action('button-clicked'), isTrailingIcon: false }
 };

Also applies to: 22-24

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 957a174 and b36b412.

📒 Files selected for processing (2)

• platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.stories.ts (1 hunks)
• platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.svelte (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.svelte

🔇 Additional comments (3)

platforms/metagram/src/lib/fragments/SettingsNavigationButton/SettingsNavigationButton.stories.ts (3)

1-3: Component imports look good.

The imports are properly structured, bringing in the necessary Svelte types, the main component, and the snippet components used in the stories.

---

5-16: Default export configuration is properly structured.

The Storybook configuration follows best practices with appropriate title path, component reference, and autodocs tag. The render function is correctly typed with ComponentProps to ensure type safety.

---

18-24: Story variants effectively demonstrate component flexibility.

The Primary and Secondary stories clearly showcase the two main variants of the component (with and without trailing icon), providing good test coverage for the component's intended usage patterns.