-
Notifications
You must be signed in to change notification settings - Fork 9
docs: added doc support for file-addition-trigger #1240
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
harish-viswa
wants to merge
9
commits into
main
Choose a base branch
from
docs/file-addition-trigger
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
70e234d
docs: added doc support for file-addition-trigger
harish-viswa 7a6d93b
Update apps/portal/src/content/docs/components/file-additions-trigger…
harish-viswa 2931842
Update apps/portal/src/content/docs/components/file-additions-trigger…
harish-viswa 7827759
Update apps/portal/src/content/docs/components/file-additions-trigger…
harish-viswa 5a73aca
Update apps/portal/src/content/docs/components/file-additions-trigger…
harish-viswa 28eeae2
Update apps/portal/src/content/docs/components/file-additions-trigger…
harish-viswa ed5f69a
Update apps/portal/src/content/docs/components/file-additions-trigger…
harish-viswa 16c9473
Update apps/portal/src/content/docs/components/file-additions-trigger…
harish-viswa 200d96d
fix: added review suggestions
harish-viswa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
71 changes: 71 additions & 0 deletions
71
apps/portal/src/content/docs/components/file-additions-trigger.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,71 @@ | ||||||||||||||
--- | ||||||||||||||
title: FileAdditionsTrigger | ||||||||||||||
description: FileAdditionsTrigger component | ||||||||||||||
--- | ||||||||||||||
|
||||||||||||||
The `FileAdditionsTrigger` component provides a UI element for creating new files or uploading files. It uses a dropdown menu to offer these options. | ||||||||||||||
|
||||||||||||||
import { DocsPage } from "@/components/docs-page"; | ||||||||||||||
|
||||||||||||||
<DocsPage.ComponentExample | ||||||||||||||
client:only | ||||||||||||||
code={`<FileAdditionsTrigger | ||||||||||||||
useTranslationStore={() => ({ t: (key, fallback) => fallback })} | ||||||||||||||
pathNewFile="/new-file" | ||||||||||||||
pathUploadFiles="/upload-files" | ||||||||||||||
/>`} | ||||||||||||||
/> | ||||||||||||||
|
||||||||||||||
## Usage | ||||||||||||||
|
||||||||||||||
```typescript jsx | ||||||||||||||
import { FileAdditionsTrigger } from '@harnessio/ui/components' | ||||||||||||||
|
||||||||||||||
// ... | ||||||||||||||
|
||||||||||||||
return ( | ||||||||||||||
<FileAdditionsTrigger | ||||||||||||||
useTranslationStore={useTranslationStoreHook} | ||||||||||||||
pathNewFile="/new-file" | ||||||||||||||
pathUploadFiles="/upload-files" | ||||||||||||||
/> | ||||||||||||||
) | ||||||||||||||
``` | ||||||||||||||
|
||||||||||||||
## API Reference | ||||||||||||||
harish-viswa marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||
|
||||||||||||||
The `FileAdditionsTrigger` component helps in navigation to create new files or upload files. | ||||||||||||||
|
||||||||||||||
```typescript jsx | ||||||||||||||
<FileAdditionsTrigger | ||||||||||||||
useTranslationStore={useTranslationStoreHook} | ||||||||||||||
pathNewFile="/new-file" | ||||||||||||||
pathUploadFiles="/upload-files" | ||||||||||||||
Comment on lines
+41
to
+43
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we add a quick comment for each of the props to briefly explain them?
Suggested change
|
||||||||||||||
/> | ||||||||||||||
``` | ||||||||||||||
|
||||||||||||||
<DocsPage.PropsTable | ||||||||||||||
props={[ | ||||||||||||||
{ | ||||||||||||||
name: "useTranslationStore", | ||||||||||||||
description: | ||||||||||||||
"Function that returns a translation store object with a 't' function for internationalization support. The 't' function takes a key and fallback text.", | ||||||||||||||
required: true, | ||||||||||||||
value: "() => { t: (key: string, fallback: string) => string }", | ||||||||||||||
}, | ||||||||||||||
{ | ||||||||||||||
name: "pathNewFile", | ||||||||||||||
description: | ||||||||||||||
"URL path to navigate to when the user selects the 'Create New File' option from the dropdown", | ||||||||||||||
required: true, | ||||||||||||||
value: "string", | ||||||||||||||
}, | ||||||||||||||
{ | ||||||||||||||
name: "pathUploadFiles", | ||||||||||||||
description: | ||||||||||||||
"URL path to navigate to when the user selects the 'Upload Files' option from the dropdown", | ||||||||||||||
required: true, | ||||||||||||||
value: "string", | ||||||||||||||
}, | ||||||||||||||
]} | ||||||||||||||
/> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.