@component-controls/render
v4.0.3
Published
framework render functions
Downloads
116
Readme
Table of contents
Overview
Logging utilities. Uses the chalk package for logging utput
Installation
This package is usually installed as part of the @component-controls package, but you can also install it standalone:
$ npm install @component-controls/logger --save-dev
API
renderers
type
defined in @component-controls/render/core/render/src/index.ts
properties
| Name | Type |
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| react*
| function (props
*story
*name
*: string
storyName
: string
id
: string
rawId
: string
doc
: string
storyFn
: function (controlValues
[string
]: any
context
: any
) => Promise
| any
description
: string
arguments
: StoryArgument
[]loc
start
*line
*: column
*: end
*line
*: column
*: 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
[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
category
: string
doc
title
*: string
type
: "story"
| "blog"
| "page"
| "tags"
| "author"
| string
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
: Story
<Props
>) => Example
<>bind
*: function (props
*: ) => Example
<Props
>source
: string
storyName
: string
id
: string
rawId
: string
doc
: string
storyFn
: StoryRenderFndescription
: string
loc
: CodeLocationsubtitle
: string
dynamic
: boolean
dynamicId
: string
component
at
*: subcomponents
: Record
<string
, (string
, Record
<string
, unknown
>, ElementType
<Props
>)>smartControls
: SmartControlsdecorators
: StoryRenderFn
[]plugins
: any
category
: string
controls
*: source
: string
storyName
: string
id
: string
rawId
: string
doc
: string
storyFn
: StoryRenderFndescription
: string
loc
: CodeLocationsubtitle
: string
dynamic
: boolean
dynamicId
: string
component
: string
| Record
<string
, unknown
> | ElementType
<Props
>subcomponents
: Record
<string
, (string
, Record
<string
, unknown
>, ElementType
<Props
>)>smartControls
: SmartControlsdecorators
: StoryRenderFn
[]plugins
: any
category
: string
controls
: ExampleControlsstories
: string
[]source
: string
fileName
: string
package
: string
testFiles
: string
[]testCoverage
: string
[]testData
: string
renderFn
: FrameworkRenderFndata
[string
]: componentsLookup
[string
]: string
MDXPage
: any
isMDXComponent
: boolean
parameters
: 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
category
: string
navSidebar
: boolean
contextSidebar
: boolean
fullPage
: boolean
values
[string
]: ComponentControl
| any
options
: any
) => any
|
| json*
| function (props
*story
*name
*: string
storyName
: string
id
: string
rawId
: string
doc
: string
storyFn
: function (controlValues
[string
]: any
context
: any
) => Promise
| any
description
: string
arguments
: StoryArgument
[]loc
start
*line
*: column
*: end
*line
*: column
*: 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
[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
category
: string
doc
title
*: string
type
: "story"
| "blog"
| "page"
| "tags"
| "author"
| string
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
>source
: string
storyName
: string
id
: string
rawId
: string
doc
: string
storyFn
: StoryRenderFndescription
: string
loc
: CodeLocationsubtitle
: string
dynamic
: boolean
dynamicId
: string
component
at
*: subcomponents
: Record
<string
, (string
, Record
<string
, unknown
>, ElementType
<Props
>)>smartControls
: SmartControlsdecorators
: StoryRenderFn
[]plugins
: any
category
: string
controls
*: stories
: string
[]source
: string
fileName
: string
package
: string
testFiles
: string
[]testCoverage
: string
[]testData
: string
renderFn
: FrameworkRenderFndata
[string
]: componentsLookup
[string
]: string
MDXPage
: any
isMDXComponent
: boolean
parameters
: 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
category
: string
navSidebar
: boolean
contextSidebar
: boolean
fullPage
: boolean
values
[string
]: ComponentControl
| any
options
: any
) => any
|