feat: modal

[ghost]

Description of change

Built a modal

Issue Number

closes #153

Type of change

• New (a change which implements a new feature)

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 modal drawer component for displaying content in a modal overlay.
  • Added Storybook stories and reusable snippets for the modal component to showcase its usage.

• Style

  • Added a utility class to hide scrollbars across all major browsers.
  • Applied consistent border-radius and padding styles to drawer panes.
  • Improved code formatting and consistency in various component files and stories, including updates to quote styles and indentation.

• Documentation

  • Updated Storybook stories to reflect new and existing components, with improved organization and readability.

[coderabbitai]

"""

Walkthrough

A new modal component based on Cupertino Pane was added, including its implementation, Storybook stories, and snippet. The fragments and UI index files were updated to export the modal. Multiple files across the codebase received formatting and stylistic updates, such as consistent indentation and quote style. A utility CSS class to hide scrollbars was also introduced.

Changes

Files / Groups	Change Summary
platforms/metagram/src/lib/fragments/Modal/Modal.svelte platforms/metagram/src/lib/fragments/Modal/Modal.stories.ts platforms/metagram/src/lib/fragments/Modal/Modal.stories.snippet.svelte	Introduced new Modal component, accompanying Storybook story, and reusable snippet for modal content.
platforms/metagram/src/lib/fragments/index.ts	Added export for Modal; switched to single quotes in export statements.
platforms/metagram/src/lib/ui/index.ts	Changed all module path delimiters from double to single quotes in export statements.
platforms/metagram/src/app.css	Added .hide-scrollbar utility class for cross-browser scrollbar hiding.
platforms/metagram/src/lib/fragments/Drawer/Drawer.svelte	Removed clickOutside directive and replaced its handler with a new dismiss function; added global styles for .pane; reformatted code indentation.
platforms/metagram/src/lib/fragments/Drawer/Drawer.stories.snippet.svelte	Reformatted export statement and snippet content for readability.
platforms/metagram/src/lib/fragments/Drawer/Drawer.stories.ts	Updated indentation in story export for consistency.
platforms/metagram/src/lib/fragments/Header/Header.stories.ts platforms/metagram/src/lib/fragments/Message/Message.stories.ts	Reformatted code for consistent indentation and switched to single quotes; no logic changes.

Sequence Diagram(s)

sequenceDiagram
    participant Storybook
    participant Modal
    participant CupertinoPane

    Storybook->>Modal: Instantiate Modal (with children, isPaneOpen, handleSwipe)
    Modal->>CupertinoPane: Initialize with options (modal, backdrop, draggable, etc.)
    Modal->>CupertinoPane: Present pane (show modal)
    CupertinoPane-->>Modal: User interacts (e.g., tap backdrop, swipe down)
    Modal->>CupertinoPane: Destroy pane (on dismiss or unmount)
    Modal-->>Storybook: Render children content inside modal

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Implement a modal using Cupertino Pane, export it, and provide Storybook stories and snippet (#153)	✅

Poem

In a meadow of code, where modals now bloom,
Cupertino Pane brings a drawer to the room.
With snippets and stories, the showcase is bright,
And scrollbars can vanish, tucked out of sight.
A hop and a skip—this update’s a delight!

　(_/)
(='.'=)
(")(")
"""

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between ba602a2 and bcadf99.

📒 Files selected for processing (1)

• platforms/metagram/src/lib/fragments/Drawer/Drawer.svelte (4 hunks)

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

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

---

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

🧹 Nitpick comments (4)

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

5-18: Consider trimming or reusing repeated placeholder content
The Lorem ipsum block is very long and repetitive, which can hamper readability. As an optional improvement, you might:

• Shorten to a single paragraph or externalize to a shared snippet.
• Use a utility to generate repeated text if multiple paragraphs are required.

platforms/metagram/src/lib/fragments/Drawer/Drawer.svelte (1)

30-36: Refine swipe‐handler implementation
The cast ('down' as string) is unnecessary since "down" is already a string literal. You can simplify to:

- if (event.detail.direction === ('down' as string)) {
+ if (event.detail.direction === 'down') {

This will keep the code cleaner while preserving type safety.

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

59-59: Missing space in className concatenation

The space is missing after the comma in the cn function call.

-	class={cn("p-5",restProps.class)}
+	class={cn("p-5", restProps.class)}

---

67-81: Excessive use of !important and hardcoded values

The styles use many !important declarations which can make future styling changes difficult. Additionally, the component has hardcoded dimensions that may not be adaptable to all use cases.

Consider:

1. Using CSS custom properties for dimensions to make them configurable
2. Reducing the use of !important by using more specific selectors
3. Using auto for overflow instead of scroll to only show scrollbars when needed

 :global(.pane) {
     width: 95% !important;
     max-height: 300px !important;
     min-height: 250px !important;
     height: auto !important;
     position: fixed !important;
     bottom: 30px !important;
     left: 50% !important;
     transform: translateX(-50%) !important;
     border-radius: 32px !important;
     padding-block-start: 20px !important;
     padding-block-end: 20px !important;
     background-color: var(--color-white) !important;
-    overflow: scroll !important;
+    overflow: auto !important;
 }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 76e861c and 15d68e8.

📒 Files selected for processing (11)

• platforms/metagram/src/app.css (1 hunks)
• platforms/metagram/src/lib/fragments/Drawer/Drawer.stories.snippet.svelte (1 hunks)
• platforms/metagram/src/lib/fragments/Drawer/Drawer.stories.ts (1 hunks)
• platforms/metagram/src/lib/fragments/Drawer/Drawer.svelte (3 hunks)
• platforms/metagram/src/lib/fragments/Header/Header.stories.ts (1 hunks)
• platforms/metagram/src/lib/fragments/Message/Message.stories.ts (1 hunks)
• platforms/metagram/src/lib/fragments/Modal/Modal.stories.snippet.svelte (1 hunks)
• platforms/metagram/src/lib/fragments/Modal/Modal.stories.ts (1 hunks)
• platforms/metagram/src/lib/fragments/Modal/Modal.svelte (1 hunks)
• platforms/metagram/src/lib/fragments/index.ts (1 hunks)
• platforms/metagram/src/lib/ui/index.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

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

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

• Main (15-19)

🔇 Additional comments (13)

platforms/metagram/src/app.css (1)

30-37: Well-implemented cross-browser scrollbar hiding utility

The new .hide-scrollbar utility class properly handles scrollbar hiding across all major browsers (Firefox, Chrome/Safari, and IE/Edge), which will improve the UI aesthetics for scrollable content in modals while maintaining scroll functionality.

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

1-11: Consistent code style improvements

The formatting changes to use single quotes and consistent tab indentation align with the project's apparent style guide. This improves readability and maintains consistency across story files.

Also applies to: 15-21, 25-31

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

1-11: Storybook organization and style improvements

The updated title from "Fragments/Header" to "UI/Header" creates a more consistent organization in Storybook. The formatting changes (single quotes and tab indentation) align with the project's style standards.

Also applies to: 15-19, 23-26, 30-33, 37-41, 45-48

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

17-18: Consistent indentation

The indentation change for the children property in the args object improves consistency with the rest of the codebase.

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

1-6: Consistent single‐quote styling applied
These exports have been updated to use single quotes uniformly, aligning with the project’s code style conventions. No functional changes detected.

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

1-7: Single‐quote consistency for fragment exports
The existing fragment exports have been converted to single quotes, matching the style guide. No API or behavior changes here.

---

8-8: New Modal export added
You’ve correctly exposed the new Modal.svelte component from the fragments index. Ensure downstream imports or documentation reference this entry.

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

1-4: Module export for snippet is correct
The <script module> block exports ModalContent as intended. This pattern matches other fragment snippets and will be consumed by the Storybook story.

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

2-4: Snippet export formatting updated
The export of DrawerContent now has consistent spacing around braces, matching other snippet modules.

---

6-84: Multi-line snippet indentation aligned
The snippet content has been reformatted into a multi-line paragraph for better readability, aligning with story formatting changes elsewhere. No logic changes.

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

7-7: Added SwipeCustomEvent type import
Typing the swipe event improves type safety. This import aligns with the updated handleDrawerSwipe signature.

---

73-73: Rendering children snippet
Using {@render children?.()} correctly invokes the passed snippet. Optionally, you could guard with {#if children} for clarity, but this is acceptable.

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

1-19: LGTM! The Storybook configuration follows expected patterns.

The story is correctly structured for a modal component, following similar patterns as other components like Drawer. The component is properly configured for auto-documentation.