feat: added doc for search-box #1248
Open
Conversation
This file contains 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
✅ Deploy Preview for harness-design ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for harness-xd-review ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
harish-viswa
force-pushed
the
docs/search-box
branch
from
88b1e36 to
a3f016b
Compare
harish-viswa
force-pushed
the
docs/search-box
branch
from
49e119d to
cb2ae7d
Compare
knagurski
requested changes
Apr 2, 2025
|
|
||
| ````typescript jsx | ||
| import { SearchBox } from '@harnessio/ui/components' | ||
|
|
There was a problem hiding this comment.
Remember the ellipsis
Suggested change
| // ... | |
| className="custom-class" | ||
| /> | ||
| ) | ||
|
|
There was a problem hiding this comment.
Missing closing backticks for code block
Comment on lines
+18
to
+20
| width="fixed" | ||
| textSize="text-sm" | ||
| showOnFocus={false} |
There was a problem hiding this comment.
We can omit things that are defaults
Suggested change
| width="fixed" | |
| textSize="text-sm" | |
| showOnFocus={false} |
Comment on lines
+12
to
+22
| code={`<SearchBox.Root | ||
| placeholder="Search..." | ||
| hasSearchIcon={true} | ||
| hasShortcut={true} | ||
| shortcutLetter="K" | ||
| shortcutModifier="alt" | ||
| width="fixed" | ||
| textSize="text-sm" | ||
| showOnFocus={false} | ||
| /> | ||
| `} |
There was a problem hiding this comment.
Looks like there's a lot of trailing white space
Suggested change
| code={`<SearchBox.Root | |
| placeholder="Search..." | |
| hasSearchIcon={true} | |
| hasShortcut={true} | |
| shortcutLetter="K" | |
| shortcutModifier="alt" | |
| width="fixed" | |
| textSize="text-sm" | |
| showOnFocus={false} | |
| /> | |
| `} | |
| code={`<SearchBox.Root | |
| placeholder="Search..." | |
| hasSearchIcon={true} | |
| hasShortcut={true} | |
| shortcutLetter="K" | |
| shortcutModifier="alt" | |
| width="fixed" | |
| textSize="text-sm" | |
| showOnFocus={false} | |
| />`} |
Comment on lines
+51
to
+65
| width="fixed" // [Optional] Width of the search box ('full' | 'fixed') | ||
| hasShortcut={true} // [Optional] Show keyboard shortcut indicator | ||
| hasSearchIcon={true} // [Optional] Show search icon | ||
| shortcutLetter="k" // [Optional] Keyboard shortcut key | ||
| shortcutModifier="cmd" // [Optional] Keyboard shortcut modifier ('cmd' | 'ctrl' | 'alt' | 'shift') | ||
| textSize={TextSize['text-sm']} // [Optional] Text size of the input | ||
| onSearch={() => searchHandler()} // [Optional] Callback when search is triggered | ||
| onFocus={() => focusHandler()} // [Optional] Callback when input is focused | ||
| handleChange={e => handleChange(e)} // [Optional] Callback when input value changes | ||
| showOnFocus={false} // [Optional] Trigger search on focus | ||
| inputClassName="h-8" // [Optional] Additional classes for the input | ||
| placeholder="Search..." // [Optional] Placeholder text | ||
| value="" // [Optional] Controlled input value | ||
| defaultValue="" // [Optional] Default input value | ||
| theme="default" // [Optional] Theme variant |
There was a problem hiding this comment.
Can we set the optional stuff as [OPTIONAL] instead of [Optional]
Suggested change
| width="fixed" // [Optional] Width of the search box ('full' | 'fixed') | |
| hasShortcut={true} // [Optional] Show keyboard shortcut indicator | |
| hasSearchIcon={true} // [Optional] Show search icon | |
| shortcutLetter="k" // [Optional] Keyboard shortcut key | |
| shortcutModifier="cmd" // [Optional] Keyboard shortcut modifier ('cmd' | 'ctrl' | 'alt' | 'shift') | |
| textSize={TextSize['text-sm']} // [Optional] Text size of the input | |
| onSearch={() => searchHandler()} // [Optional] Callback when search is triggered | |
| onFocus={() => focusHandler()} // [Optional] Callback when input is focused | |
| handleChange={e => handleChange(e)} // [Optional] Callback when input value changes | |
| showOnFocus={false} // [Optional] Trigger search on focus | |
| inputClassName="h-8" // [Optional] Additional classes for the input | |
| placeholder="Search..." // [Optional] Placeholder text | |
| value="" // [Optional] Controlled input value | |
| defaultValue="" // [Optional] Default input value | |
| theme="default" // [Optional] Theme variant | |
| width="fixed" // [OPTIONAL] Width of the search box ('full' | 'fixed') | |
| hasShortcut={true} // [OPTIONAL] Show keyboard shortcut indicator | |
| hasSearchIcon={true} // [OPTIONAL] Show search icon | |
| shortcutLetter="k" // [OPTIONAL] Keyboard shortcut key | |
| shortcutModifier="cmd" // [OPTIONAL] Keyboard shortcut modifier ('cmd' | 'ctrl' | 'alt' | 'shift') | |
| textSize={TextSize['text-sm']} // [OPTIONAL] Text size of the input | |
| onSearch={() => searchHandler()} // [OPTIONAL] Callback when search is triggered | |
| onFocus={() => focusHandler()} // [OPTIONAL] Callback when input is focused | |
| handleChange={e => handleChange(e)} // [OPTIONAL] Callback when input value changes | |
| showOnFocus={false} // [OPTIONAL] Trigger search on focus | |
| inputClassName="h-8" // [OPTIONAL] Additional classes for the input | |
| placeholder="Search..." // [OPTIONAL] Placeholder text | |
| value="" // [OPTIONAL] Controlled input value | |
| defaultValue="" // [OPTIONAL] Default input value | |
| theme="default" // [OPTIONAL] Theme variant |
Comment on lines
+57
to
+59
| onSearch={() => searchHandler()} // [Optional] Callback when search is triggered | ||
| onFocus={() => focusHandler()} // [Optional] Callback when input is focused | ||
| handleChange={e => handleChange(e)} // [Optional] Callback when input value changes |
There was a problem hiding this comment.
Can we remove the inline anonymous functions?
Suggested change
| onSearch={() => searchHandler()} // [Optional] Callback when search is triggered | |
| onFocus={() => focusHandler()} // [Optional] Callback when input is focused | |
| handleChange={e => handleChange(e)} // [Optional] Callback when input value changes | |
| onSearch={searchHandler} // [Optional] Callback when search is triggered | |
| onFocus={focusHandler} // [Optional] Callback when input is focused | |
| handleChange={handleChange} // [Optional] Callback when input value changes |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
closes #1247