store* |
Store
error : string
config *
author : string
category : string
title : string
logo : string | ReactNode
app
propTypes : WeakValidationMap <P > | undefined
contextTypes : ValidationMap <any > | undefined
defaultProps : Partial <P > | undefined
displayName *: description : string
copyright : string
language : string
image : string
links : (DetailedHTMLProps <>)[]
seo : ReactChild | ReactFragment | ReactPortal | boolean | null | undefined
pages
[string ]: type
basePath *:
sideNav *:
label *:
indexHome *:
topMenu *:
container *:
tabs *:
navSidebar *:
contextSidebar *:
fullPage *:
theme
[string ]: any
storySort : function (
a *: string
b *: string ) => number
toolbar
left : ActionItems
right : ActionItems footer
left : ActionItems
right : ActionItems sidebar : ActionItem []
menu : StaticMenuItem []
components : Record <string , unknown >
analytics : any
component : string | Record <string , unknown > | ElementType <Props >
subcomponents : Record <string , (string , Record <string , unknown >, ElementType <Props >)>
controls
[string ]: ComponentControlText | ComponentControlBoolean | ComponentControlColor | ComponentControlDate | ComponentControlObject <P > | ComponentControlButton | ComponentControlOptions | ComponentControlNumber | ComponentControlArray | ComponentControlFiles
smartControls
smart : boolean
include : string [] | IncludeFn
exclude : string [] | IncludeFn
decorators : StoryRenderFn []
plugins : any
renderFn : function (
props *
story *
name *:
storyName *:
id *:
rawId *:
doc *:
storyFn *:
description *:
arguments *:
loc *:
source *:
subtitle *:
dynamic *:
dynamicId *:
component *:
subcomponents *:
controls *:
smartControls *:
decorators *:
plugins *:
category *: doc
title *:
type *:
route *:
date *:
dateModified *:
status *:
tags *:
keywords *:
description *:
image *:
author *:
order *:
menu *:
template *:
stories *:
source *:
fileName *:
package *:
testFiles *:
testCoverage *:
testData *:
renderFn *:
data *:
componentsLookup *:
MDXPage *:
isMDXComponent *:
parameters *:
component *:
subcomponents *:
controls *:
smartControls *:
decorators *:
plugins *:
category *:
navSidebar *:
contextSidebar *:
fullPage *: values : ExampleControls
options : any
) => any
webpack : Configuration | WebpackConfigFn
finalWebpack : Configuration | WebpackConfigFn
presets : RuleType []
configPath : string
distFolder : string
bundleName : string
staticFolder : string
cssFileName : string
logOptions : Partial <LogOptions >
mode : "none" | "development" | "production"
loaders
encodeHTML *: encodeHTML
at *: function (
index *: ) => T | undefined
module : string
ident : string
loader : string
options : string | type
stories : string | string []
files : string | string []
siteRoot : string
ignore : string []
categories : DocType []
siteMap : type | boolean
siteUrl : string
instrument : any
search
indexingModule : string
searchingModule *: string
fields : SearchFields []
emptySearchDocuments : string []
hitsPerPage : number
options : any
tokens
figmaAccessToken : string
githubAccessToken : string
docs *
[string ]: type
[string ]: any
title *: string
type : DocType
route : string
date : string
dateModified : string
status : "draft" | "published"
tags : string []
keywords : string []
description : string | JSX.Element
image : string
author : string
order : number
menu : string
template
bind *: function (
props *: ) => Example <Props >
category : string
description : string
component
encodeHTML *:
at *: subcomponents : Record <string , (string , Record <string , unknown >, ElementType <Props >)>
smartControls : SmartControls
decorators : StoryRenderFn []
plugins : any
source : string
storyName : string
id : string
rawId : string
doc : string
storyFn : StoryRenderFn
loc
start *:
end *: subtitle : string
dynamic : boolean
dynamicId : string
controls : ExampleControls stories : string []
source : string
fileName : string
package : string
testFiles : string []
testCoverage : string []
testData : string
renderFn : function (
props *: ) => any
data
[string ]: componentsLookup
[string ]: string
MDXPage : any
isMDXComponent : boolean
parameters : any
component
encodeHTML *: encodeHTML
at *: function (
index *: ) => T | undefined
subcomponents : Record <string , (string , Record <string , unknown >, ElementType <Props >)>
controls : ComponentControls
smartControls : SmartControls
decorators : StoryRenderFn []
plugins : any
category : string
navSidebar : boolean
contextSidebar : boolean
fullPage : boolean
stories *
[string ]: type
name *: string
storyName : string
id : string
rawId : string
doc : string
storyFn : StoryRenderFn
description : string
arguments : StoryArgument []
loc
start *:
end *: source : string
subtitle : string
dynamic : boolean
dynamicId : string
component
encodeHTML *: encodeHTML
at *: function (
index *: ) => T | undefined
subcomponents : Record <string , (string , Record <string , unknown >, ElementType <Props >)>
controls : ComponentControls
smartControls : SmartControls
decorators : StoryRenderFn []
plugins : any
category : string
components *
[string ]: interface
name *: string
importedName : "default" | "namespace" | string
from : string
request : string
fileName : string
propsInfoFile : string
loc
start *:
end *: package : string
source : string
info
displayName *:
description *:
props *: externalDependencies
[string ]: (Omit <ImportType , "from" >)[] localDependencies
[string ]: (Omit <ImportType , "from" >)[] jsx : JSXNode []
fileInfo
dateCreated *:
dateModified *:
commits *:
sloc *: jest
results *:
coverage *:
packages *
[string ]: interface
fileHash *: string
name : string
version : string
dependencies
[string ]: PackageDependency devDependencies
[string ]: PackageDependency peerDependencies
[string ]: PackageDependency privateNpm : boolean
repository *
browse : string
docs : string
issues : string
addObserver *: function (
observer *: function (
story : Story ) => void ) => void
removeObserver *: function (
observer *: function (
story : Story ) => void ) => void
updateStory *: function (
story *
name *: string
storyName : string
id : string
rawId : string
doc : string
storyFn : StoryRenderFn
description : string
arguments : StoryArgument []
loc
start *:
end *: source : string
subtitle : string
dynamic : boolean
dynamicId : string
component : string | Record <string , unknown > | ElementType <Props >
subcomponents : Record <string , (string , Record <string , unknown >, ElementType <Props >)>
controls : ComponentControls
smartControls : SmartControls
decorators : StoryRenderFn []
plugins : any
category : string
) => void
search : function (
store *
error *:
config *:
docs *:
stories *:
components *:
packages *:
addObserver *:
removeObserver *:
updateStory *:
search *: ) => SearchResult
items *: SearchItem []
searchFn *: function (
search *: string ) => void
provider
logo *: ReactNode
url *: string
name *: string
|
|
|