feat: FileInput

[ghost]

Description of change

Built File input component

Issue Number

closes #149

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 file input component with customizable labels, file type restrictions, and a cancel option for uploaded files.
  • Added Storybook documentation and interactive examples for the new file input component.

[coderabbitai]

Walkthrough

A new InputFile Svelte component has been introduced, providing a styled file input with customizable labels, file type restrictions, and cancel functionality. The component is exported for use in the library, and a Storybook story is added for documentation and testing, demonstrating its usage and props.

Changes

File(s)	Change Summary
platforms/metagram/src/lib/fragments/InputFile/InputFile.svelte	Added new InputFile Svelte component with bindable file input, customizable labels, and cancel UI.
platforms/metagram/src/lib/fragments/InputFile/InputFile.stories.ts	Added Storybook story for InputFile with default export and a main story for demonstration.
platforms/metagram/src/lib/fragments/index.ts	Exported InputFile component from the fragments module index.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant InputFile
  participant ParentComponent

  User->>InputFile: Clicks label to select file
  InputFile->>User: Opens file picker dialog
  User->>InputFile: Selects file(s)
  InputFile->>ParentComponent: Updates bound files prop
  InputFile->>User: Displays selected file name and cancel button
  User->>InputFile: Clicks cancel button
  InputFile->>ParentComponent: Calls oncancel callback
  InputFile->>User: Clears file selection UI

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Build Input file component according to design (#149)	✅
Files should be bindable (#149)	✅

Poem

A file input hops in, shiny and new,
With labels and icons, and canceling too.
Bind your files, click to upload,
A rabbit’s delight in UI bestowed!
Now Storybook tells the tale just right—
Hooray for new features, and code that’s light!
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

📜 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 2beb5fe and e48e3a2.

📒 Files selected for processing (3)

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

✅ Files skipped from review due to trivial changes (3)

• platforms/metagram/src/lib/fragments/index.ts
• platforms/metagram/src/lib/fragments/InputFile/InputFile.stories.ts
• platforms/metagram/src/lib/fragments/InputFile/InputFile.svelte

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

🧹 Nitpick comments (3)

platforms/metagram/src/lib/ui/InputFile/InputFile.svelte (2)

11-13: Remove console logging statements before production.

The effect is logging the files to the console on every change, which appears to be debugging code that should be removed before production deployment.

 $effect(() => {
-	console.log(files);
 });

---

16-16: Consider adding file type restrictions and ARIA attributes.

The file input doesn't specify any file type restrictions, and lacks accessibility attributes.

Enhance the input with accept attribute and accessibility improvements:

- <input id={uniqueId} type="file" bind:files class="hidden" />
+ <input 
+   id={uniqueId} 
+   type="file" 
+   bind:files 
+   class="hidden" 
+   accept="image/*"
+   aria-label="Upload photo" 
+ />

platforms/metagram/src/lib/ui/InputFile/InputFile.stories.ts (1)

13-15: Add meaningful default args to the story.

The Main story is exported with empty args, but the component expects a placeholder property.

export const Main = {
-  args: {}
+  args: {
+    placeholder: 'Click to upload a photo'
+  }
};

📜 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 a9e703d and f6c1ce8.

📒 Files selected for processing (3)

• platforms/metagram/src/lib/ui/InputFile/InputFile.stories.ts (1 hunks)
• platforms/metagram/src/lib/ui/InputFile/InputFile.svelte (1 hunks)
• platforms/metagram/src/lib/ui/index.ts (1 hunks)

🔇 Additional comments (1)

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

4-4: LGTM! The export follows the existing pattern.

The export statement for the new InputFile component follows the established pattern of the other UI components in this file.

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (1)

platforms/metagram/src/lib/ui/InputFile/InputFile.svelte (1)

5-8: The 'placeholder' prop is defined but not used

The interface defines a placeholder prop, but the component still uses the hardcoded text "Click to upload a photo" instead of using this prop.

- Click to upload a photo
+ {placeholder || 'Click to upload a photo'}

Also applies to: 43-43

🧹 Nitpick comments (2)

platforms/metagram/src/lib/ui/InputFile/InputFile.svelte (2)

31-31: Improve file name truncation logic

While the current implementation shows the first 10 characters (improved from 5), it still doesn't preserve the file extension and could truncate important information for short filenames.

- <h3 class="text-black-800">{files[0].name.slice(0, 10) + '...'}</h3>
+ <h3 class="text-black-800">
+   {#if files[0].name.length > 20}
+     {files[0].name.slice(0, 10)}...{files[0].name.slice(-8)} 
+   {:else}
+     {files[0].name}
+   {/if}
+ </h3>

---

12-12: Consider using a more robust ID generation method

The current unique ID generation is simple but could potentially lead to duplicates. Consider using a more robust method such as a UUID library.

- const uniqueId = Math.random().toString().split('.')[1];
+ import { v4 as uuidv4 } from 'uuid';
+ const uniqueId = uuidv4();

Remember to add uuid to your project dependencies if it's not already installed.

📜 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 f6c1ce8 and cd540cd.

📒 Files selected for processing (1)

• platforms/metagram/src/lib/ui/InputFile/InputFile.svelte (1 hunks)

[sosweetham]

fix coderabbit suggestions too

[sosweetham]

also add doc comments to the end

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (1)

platforms/metagram/src/lib/ui/InputFile/InputFile.svelte (1)

34-34: 🛠️ Refactor suggestion

Improve filename truncation logic.

The current implementation slices the first 10 characters of the filename regardless of file length, which could lead to poor user experience for short filenames or filenames with important information in the middle or end.

- <h3 class="text-black-800">{files[0].name.slice(0, 10) + '...'}</h3>
+ <h3 class="text-black-800">
+   {#if files[0].name.length > 20}
+     {files[0].name.slice(0, 10)}...{files[0].name.slice(-7)}
+   {:else}
+     {files[0].name}
+   {/if}
+ </h3>

🧹 Nitpick comments (4)

platforms/metagram/src/lib/ui/InputFile/InputFile.svelte (4)

13-19: Consider making oncancel optional.

The oncancel prop is required in the interface but has no default value. This could cause runtime errors if the component is used without providing this callback.

interface IInputFileProps {
	files: FileList | undefined;
	accept: string;
	label: string;
	cancelLabel: string;
-	oncancel: () => void;
+	oncancel?: () => void;
}

let {
	files = $bindable(),
	accept = 'image/*',
	label = 'Click to upload a photo',
	cancelLabel = 'Delete upload',
-	oncancel
+	oncancel = () => {}
}: IInputFileProps = $props();

---

21-21: Use a more deterministic ID generation approach.

Using Math.random() for ID generation could potentially lead to duplicate IDs in rare cases and might cause hydration mismatches if server-side rendering is used.

Consider using a more deterministic approach such as:

- const uniqueId = Math.random().toString().split('.')[1];
+ const uniqueId = `file-input-${Date.now().toString(36)}`;

Or if you're using this pattern in multiple components, consider creating a utility function:

function generateUniqueId(prefix: string): string {
  return `${prefix}-${Date.now().toString(36)}-${Math.random().toString(36).substr(2, 5)}`;
}

---

31-48: Add support for multiple file selection.

The component only displays the first file's name when multiple files are selected. Consider enhancing the UI to handle multiple files better.

{#if files}
	<div class="flex flex-col items-center gap-2">
		<HugeiconsIcon size="24px" icon={Album01Icon} color="var(--color-black-600)" />
-		<h3 class="text-black-800">{files[0].name.slice(0, 10) + '...'}</h3>
+		{#if files.length === 1}
+			<h3 class="text-black-800">
+				{#if files[0].name.length > 20}
+					{files[0].name.slice(0, 10)}...{files[0].name.slice(-7)}
+				{:else}
+					{files[0].name}
+				{/if}
+			</h3>
+		{:else}
+			<h3 class="text-black-800">{files.length} files selected</h3>
+		{/if}
		<button
			type="button"
-			{oncancel}
+			on:click={oncancel}
			class="text-brand-burnt-orange underline decoration-solid"
		>
			{cancelLabel}
		</button>
	</div>
{:else}
	<div class="flex flex-col items-center gap-2">
		<HugeiconsIcon size="24px" icon={Album01Icon} color="var(--color-black-600)" />
		{label}
	</div>
{/if}

---

25-25: Consider adding multiple file selection support.

The input element doesn't have the multiple attribute, limiting users to selecting only one file at a time. Consider adding this as a configurable option.

interface IInputFileProps {
	files: FileList | undefined;
	accept: string;
	label: string;
	cancelLabel: string;
	oncancel: () => void;
+	multiple?: boolean;
}

let {
	files = $bindable(),
	accept = 'image/*',
	label = 'Click to upload a photo',
	cancelLabel = 'Delete upload',
-	oncancel
+	oncancel,
+	multiple = false
}: IInputFileProps = $props();

...

- <input id={uniqueId} type="file" bind:files class="hidden" {accept} bind:this={inputFile} />
+ <input id={uniqueId} type="file" bind:files class="hidden" {accept} bind:this={inputFile} {multiple} />

📜 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 cd540cd and 2beb5fe.

📒 Files selected for processing (2)

• platforms/metagram/src/lib/ui/InputFile/InputFile.svelte (1 hunks)
• platforms/metagram/src/lib/utils/index.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• platforms/metagram/src/lib/utils/index.ts

🔇 Additional comments (2)

platforms/metagram/src/lib/ui/InputFile/InputFile.svelte (2)

5-11: Interface properly defines all required props.

The component interface clearly defines all the necessary properties with appropriate types. This matches the feedback from previous reviews about making components more configurable.

---

51-84: Documentation is thorough and helpful.

The documentation comments are well-structured and provide clear information about the component's purpose, props, and usage. This aligns with the PR comment requesting additional documentation.

Consider adding a note about multiple file selection support to make the documentation even more complete.

[sosweetham]

lgtm