A next-generation tool to create blazing-fast documentation sites
API
created:3/5/2021
updated:3/5/2021
loc
68
comments
6%
passed
2
coverage
13%

Search

avatar of atanasster
@component-controls/blocks
3.14.5

search input component connected to the store

import { Search } from '@component-controls/blocks';

Overview

Name
Description
Default
SearchInputOwnProps(4 properties)
onSelect

on select a search item.

((item: DocInfo) => void)
-
children

children is a render prop to allow custom rendering of items, one at a time

((((props: SearchBoxCallbackProps<DocInfo>) => ReactNode) & (boolean | ReactChild | ReactFragment | ReactPortal | null)) & (boolean | ... 3 more ... | null))
-
popoverProps

customize the popover

PopoverProps
-
render

custom renver of the search items popup

((rendered: ReactNode) => ReactNode)
-
InputHTMLAttributes(34 properties)
SpaceProps(28 properties)
HTMLAttributes(43 properties)
Attributes(2 properties)
AriaAttributes(48 properties)
DOMAttributes(159 properties)
BoxOwnProps(3 properties)
BackgroundColorProps(2 properties)
OpacityProps(1 properties)

Commits

Date
Author
Commit Message
4/29/2021

atanasster

avatar of atanasster
fix: mock store search
12/23/2020

atanasster

avatar of atanasster
feat: add algolia confurable site search
11/16/2020

atanasster

avatar of atanasster
fix: search in JSX doc.description
11/15/2020

atanasster

avatar of atanasster
feat: bind templates to stories
11/15/2020

atanasster

avatar of atanasster
fix: document and example ts types update
10/6/2020

atanasster

avatar of atanasster
chore: replace lunr with fuse.js
7/24/2020

atanasster

avatar of atanasster
chore: move store hooks to store package
7/23/2020

atanasster

avatar of atanasster
chore: more recoil
7/8/2020

atanasster

avatar of atanasster
fix: optimize initial search loading
7/8/2020

atanasster

avatar of atanasster
chore: rename DocumentType to DocType
19 commits
package
imports
peer
SearchInputPropsSearchInputLink
DocInfo
useSearch
react
^17.0.1
FC
*
theme-ui
^0.8.4
jsxThemeTextBox
file
imports
"../DocumentItem"
DocumentItem