whale-docgen-render
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.6 • Public • Published

    whale-docgen-render

    TNPM version TNPM downloads 提Bug 提需求

    财鲸组件文档渲染

    安装方法

    $ tnpm install whale-docgen-render --save

    如何iceworks中使用组件

    API

    DocStructureCollapse

    折叠样式文档组件。

    参数 说明 类型 可选值 默认值
    props (必填) 需要渲染的组件字段 WmProps

    DocStructureTypesCollapse

    折叠样式文档组件。

    参数 说明 类型 可选值 默认值
    types (必填) 需要渲染的组件字段 WmPropItemType[]

    DocStructureTable

    表格样式文档组件。

    参数 说明 类型 可选值 默认值
    props (必填) 需要渲染的组件字段 WmProps
    prefix 样式类名的品牌前缀 string
    size 尺寸 small为紧凑模式 "small" | "medium" "small", "medium"
    className 自定义类名 string
    style 自定义内联样式 CSSProperties
    columns any[]
    tableLayout 表格元素的 table-layout 属性,设为 fixed 表示内容不会影响列的布局 "fixed" | "auto" "fixed", "auto"
    tableWidth 表格的总长度,可以这么用:设置表格总长度 、设置部分列的宽度,这样表格会按照剩余空间大小,自动其他列分配宽度 number
    dataSource 表格展示的数据源 any[]
    onRowClick 点击表格每一行触发的事件 (record: any, index: number, e: MouseEvent<Element, MouseEvent>) => void
    onRowMouseEnter 悬浮在表格每一行的时候触发的事件 (record: any, index: number, e: MouseEvent<Element, MouseEvent>) => void
    onRowMouseLeave 离开表格每一行的时候触发的事件 (record: any, index: number, e: MouseEvent<Element, MouseEvent>) => void
    onSort 点击列排序触发的事件 (dataIndex: string, order: string) => void
    onFilter 点击过滤确认按钮触发的事件 (filterParams: any) => void
    onResizeChange 重设列尺寸的时候触发的事件 (dataIndex: string, value: number) => void
    getRowProps 设置每一行的属性,如果返回值和其他针对行操作的属性冲突则无效。 (record: any, index: number) => any
    rowProps (record: any, index: number) => any
    getCellProps 设置单元格的属性,通过该属性可以进行合并单元格 (rowIndex: number, colIndex: number, dataIndex: string, record: any) => any
    cellProps (rowIndex: number, colIndex: number, dataIndex: string, record: any) => any
    hasBorder 表格是否具有边框 boolean
    hasHeader 表格是否具有头部 boolean
    isZebra 表格是否是斑马线 boolean
    loading 表格是否在加载中 boolean
    loadingComponent 自定义 Loading 组件 请务必传递 props, 使用方式: loadingComponent={props => <Loading {...props}/>} (props: LoadingProps) => ReactNode
    filterParams 当前过滤的的keys,使用此属性可以控制表格的头部的过滤选项中哪个菜单被选中,格式为 {dataIndex: {selectedKeys:[]}} 示例: 假设要控制dataIndex为id的列的过滤菜单中key为one的菜单项选中 `<Table filterParams={{id: {selectedKeys: ['one']}}}/>` { [propName: string]: any; }
    sort 当前排序的字段,使用此属性可以控制表格的字段的排序,格式为{dataIndex: 'asc'} { [propName: string]: any; }
    sortIcons 自定义排序按钮,例如上下排布的: `{desc: <Icon style={{top: '6px', left: '4px'}} type={'arrow-down'} size="small" />, asc: <Icon style={{top: '-6px', left: '4px'}} type={'arrow-up'} size="small" />}` { desc?: ReactNode; asc?: ReactNode; }
    locale 自定义国际化文案对象 { ok: string; reset: string; empty: string; asc: string; desc: string; expanded: string; folded: string; filter: string; selectAll: string; }
    emptyContent 设置数据为空的时候的表格内容展现 ReactNode
    primaryKey dataSource当中数据的主键,如果给定的数据源中的属性不包含该主键,会造成选择状态全部选中 string
    expandedRowRender 额外渲染行的渲染函数 (record: any, index: number) => ReactElement<any, string | JSXElementConstructor<any>>
    rowExpandable (record: any) => boolean
    expandedRowIndent 额外渲染行的缩进 any[]
    openRowKeys 默认情况下展开的渲染行或者Tree, 传入此属性为受控状态 any[]
    hasExpandedRowCtrl 是否显示点击展开额外渲染行的+号按钮 boolean
    getExpandedColProps 设置额外渲染行的属性 <IRecord extends unknown = any>(record: IRecord, index: number) => object | Record<string | number, any>
    onRowOpen 在额外渲染行或者Tree展开或者收起的时候触发的事件 (openRowKeys: any[], currentRowKey: string, expanded: boolean, currentRecord: any) => void
    onExpandedRowClick 点击额外渲染行触发的事件 (record: any, index: number, e: MouseEvent<Element, MouseEvent>) => void
    fixedHeader 表头是否固定,该属性配合maxBodyHeight使用,当内容区域的高度超过maxBodyHeight的时候,在内容区域会出现滚动条 boolean
    maxBodyHeight 最大内容区域的高度,在`fixedHeader`为`true`的时候,超过这个高度会出现滚动条 string | number string, number
    rowSelection 是否启用选择模式 { getProps?: (record: any, index: number) => void; onChange?: (selectedRowKeys: any[], records: any[]) => void; onSelect?: (selected: boolean, record: any, records: any[]) => void; onSelectAll?: (selected: boolean, records: any[]) => void; ... 4 more ...; titleAddons?: () => any; }
    stickyHeader 表头是否是sticky boolean
    offsetTop 距离窗口顶部达到指定偏移量后触发 number
    affixProps affix组件的的属性 AffixProps
    indent 在tree模式下的缩进尺寸, 仅在isTree为true时候有效 number
    isTree 开启Table的tree模式, 接收的数据格式中包含children则渲染成tree table boolean
    useVirtual 是否开启虚拟滚动 boolean
    scrollToRow 滚动到指定行 number
    rowHeight 设置行高 number | (() => void) number, () => void
    onBodyScroll 在内容区域滚动的时候触发的函数 () => void
    expandedIndexSimulate 开启时,getExpandedColProps() / getRowProps() / expandedRowRender() 的第二个参数 index (该行所对应的序列) 将按照01,2,3,4...的顺序返回,否则返回真实index(0,2,4,6... / 1,3,5,7...) boolean
    crossline 在 hover 时出现十字参考轴,适用于表头比较复杂,需要做表头分类的场景。 boolean
    defaultChecked boolean
    defaultValue string | number | readonly string[] string, number, readonly string[]
    suppressContentEditableWarning boolean
    suppressHydrationWarning boolean
    accessKey string
    contentEditable Booleanish | "inherit" false, true, "true", "false", "inherit"
    contextMenu string
    dir string
    draggable Booleanish
    hidden boolean
    id string
    lang string
    placeholder string
    slot string
    spellCheck Booleanish
    tabIndex number
    title string
    translate "yes" | "no" "yes", "no"
    radioGroup string
    role string
    about string
    datatype string
    inlist any
    property string
    resource string
    typeof string
    vocab string
    autoCapitalize string
    autoCorrect string
    autoSave string
    color string
    itemProp string
    itemScope boolean
    itemType string
    itemID string
    itemRef string
    results number
    security string
    unselectable "on" | "off" "on", "off"
    inputMode Hints at the type of data that might be entered by the user while editing the element or its contents @see https ://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" "none", "text", "tel", "url", "email", "numeric", "decimal", "search"
    is Specify that a standard HTML element should behave like a defined custom built-in element @see https ://html.spec.whatwg.org/multipage/custom-elements.html#attr-is string
    aria-activedescendant Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. string
    aria-atomic Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. boolean | "true" | "false" false, true, "true", "false"
    aria-autocomplete Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. "none" | "inline" | "list" | "both" "none", "inline", "list", "both"
    aria-busy Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. boolean | "true" | "false" false, true, "true", "false"
    aria-checked Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. @see aria-pressed @see aria-selected. boolean | "true" | "false" | "mixed" false, true, "true", "false", "mixed"
    aria-colcount Defines the total number of columns in a table, grid, or treegrid. @see aria-colindex. number
    aria-colindex Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. @see aria-colcount @see aria-colspan. number
    aria-colspan Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-colindex @see aria-rowspan. number
    aria-controls Identifies the element (or elements) whose contents or presence are controlled by the current element. @see aria-owns. string
    aria-current Indicates the element that represents the current item within a container or set of related elements. boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" false, true, "true", "false", "page", "step", "location", "date", "time"
    aria-describedby Identifies the element (or elements) that describes the object. @see aria-labelledby string
    aria-details Identifies the element that provides a detailed, extended description for the object. @see aria-describedby. string
    aria-disabled Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. @see aria-hidden @see aria-readonly. boolean | "true" | "false" false, true, "true", "false"
    aria-dropeffect Indicates what functions can be performed when a dragged object is released on the drop target. @deprecated in ARIA 1.1 "none" | "copy" | "execute" | "link" | "move" | "popup" "none", "copy", "execute", "link", "move", "popup"
    aria-errormessage Identifies the element that provides an error message for the object. @see aria-invalid @see aria-describedby. string
    aria-expanded Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. boolean | "true" | "false" false, true, "true", "false"
    aria-flowto Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. string
    aria-grabbed Indicates an element's "grabbed" state in a drag-and-drop operation. @deprecated in ARIA 1.1 boolean | "true" | "false" false, true, "true", "false"
    aria-haspopup Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog" false, true, "true", "false", "menu", "listbox", "tree", "grid", "dialog"
    aria-hidden Indicates whether the element is exposed to an accessibility API. @see aria-disabled. boolean | "true" | "false" false, true, "true", "false"
    aria-invalid Indicates the entered value does not conform to the format expected by the application. @see aria-errormessage. boolean | "true" | "false" | "grammar" | "spelling" false, true, "true", "false", "grammar", "spelling"
    aria-keyshortcuts Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. string
    aria-label Defines a string value that labels the current element. @see aria-labelledby. string
    aria-labelledby Identifies the element (or elements) that labels the current element. @see aria-describedby. string
    aria-level Defines the hierarchical level of an element within a structure. number
    aria-live Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. "off" | "assertive" | "polite" "off", "assertive", "polite"
    aria-modal Indicates whether an element is modal when displayed. boolean | "true" | "false" false, true, "true", "false"
    aria-multiline Indicates whether a text box accepts multiple lines of input or only a single line. boolean | "true" | "false" false, true, "true", "false"
    aria-multiselectable Indicates that the user may select more than one item from the current selectable descendants. boolean | "true" | "false" false, true, "true", "false"
    aria-orientation Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. "horizontal" | "vertical" "horizontal", "vertical"
    aria-owns Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. @see aria-controls. string
    aria-placeholder Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. string
    aria-posinset Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-setsize. number
    aria-pressed Indicates the current "pressed" state of toggle buttons. @see aria-checked @see aria-selected. boolean | "true" | "false" | "mixed" false, true, "true", "false", "mixed"
    aria-readonly Indicates that the element is not editable, but is otherwise operable. @see aria-disabled. boolean | "true" | "false" false, true, "true", "false"
    aria-relevant Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. @see aria-atomic. "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" "text", "additions", "additions removals", "additions text", "all", "removals", "removals additions", "removals text", "text additions", "text removals"
    aria-required Indicates that user input is required on the element before a form may be submitted. boolean | "true" | "false" false, true, "true", "false"
    aria-roledescription Defines a human-readable, author-localized description for the role of an element. string
    aria-rowcount Defines the total number of rows in a table, grid, or treegrid. @see aria-rowindex. number
    aria-rowindex Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. @see aria-rowcount @see aria-rowspan. number
    aria-rowspan Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-rowindex @see aria-colspan. number
    aria-selected Indicates the current "selected" state of various widgets. @see aria-checked @see aria-pressed. boolean | "true" | "false" false, true, "true", "false"
    aria-setsize Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-posinset. number
    aria-sort Indicates if items in a table or grid are sorted in ascending or descending order. "none" | "ascending" | "descending" | "other" "none", "ascending", "descending", "other"
    aria-valuemax Defines the maximum allowed value for a range widget. number
    aria-valuemin Defines the minimum allowed value for a range widget. number
    aria-valuenow Defines the current value for a range widget. @see aria-valuetext. number
    aria-valuetext Defines the human readable text alternative of aria-valuenow for a range widget. string
    dangerouslySetInnerHTML { __html: string; }
    onCopy ClipboardEventHandler<HTMLElement>
    onCopyCapture ClipboardEventHandler<HTMLElement>
    onCut ClipboardEventHandler<HTMLElement>
    onCutCapture ClipboardEventHandler<HTMLElement>
    onPaste ClipboardEventHandler<HTMLElement>
    onPasteCapture ClipboardEventHandler<HTMLElement>
    onCompositionEnd CompositionEventHandler<HTMLElement>
    onCompositionEndCapture CompositionEventHandler<HTMLElement>
    onCompositionStart CompositionEventHandler<HTMLElement>
    onCompositionStartCapture CompositionEventHandler<HTMLElement>
    onCompositionUpdate CompositionEventHandler<HTMLElement>
    onCompositionUpdateCapture CompositionEventHandler<HTMLElement>
    onFocus FocusEventHandler<HTMLElement>
    onFocusCapture FocusEventHandler<HTMLElement>
    onBlur FocusEventHandler<HTMLElement>
    onBlurCapture FocusEventHandler<HTMLElement>
    onChange FormEventHandler<HTMLElement>
    onChangeCapture FormEventHandler<HTMLElement>
    onBeforeInput FormEventHandler<HTMLElement>
    onBeforeInputCapture FormEventHandler<HTMLElement>
    onInput FormEventHandler<HTMLElement>
    onInputCapture FormEventHandler<HTMLElement>
    onReset FormEventHandler<HTMLElement>
    onResetCapture FormEventHandler<HTMLElement>
    onSubmit FormEventHandler<HTMLElement>
    onSubmitCapture FormEventHandler<HTMLElement>
    onInvalid FormEventHandler<HTMLElement>
    onInvalidCapture FormEventHandler<HTMLElement>
    onLoad ReactEventHandler<HTMLElement>
    onLoadCapture ReactEventHandler<HTMLElement>
    onError ReactEventHandler<HTMLElement>
    onErrorCapture ReactEventHandler<HTMLElement>
    onKeyDown KeyboardEventHandler<HTMLElement>
    onKeyDownCapture KeyboardEventHandler<HTMLElement>
    onKeyPress KeyboardEventHandler<HTMLElement>
    onKeyPressCapture KeyboardEventHandler<HTMLElement>
    onKeyUp KeyboardEventHandler<HTMLElement>
    onKeyUpCapture KeyboardEventHandler<HTMLElement>
    onAbort ReactEventHandler<HTMLElement>
    onAbortCapture ReactEventHandler<HTMLElement>
    onCanPlay ReactEventHandler<HTMLElement>
    onCanPlayCapture ReactEventHandler<HTMLElement>
    onCanPlayThrough ReactEventHandler<HTMLElement>
    onCanPlayThroughCapture ReactEventHandler<HTMLElement>
    onDurationChange ReactEventHandler<HTMLElement>
    onDurationChangeCapture ReactEventHandler<HTMLElement>
    onEmptied ReactEventHandler<HTMLElement>
    onEmptiedCapture ReactEventHandler<HTMLElement>
    onEncrypted ReactEventHandler<HTMLElement>
    onEncryptedCapture ReactEventHandler<HTMLElement>
    onEnded ReactEventHandler<HTMLElement>
    onEndedCapture ReactEventHandler<HTMLElement>
    onLoadedData ReactEventHandler<HTMLElement>
    onLoadedDataCapture ReactEventHandler<HTMLElement>
    onLoadedMetadata ReactEventHandler<HTMLElement>
    onLoadedMetadataCapture ReactEventHandler<HTMLElement>
    onLoadStart ReactEventHandler<HTMLElement>
    onLoadStartCapture ReactEventHandler<HTMLElement>
    onPause ReactEventHandler<HTMLElement>
    onPauseCapture ReactEventHandler<HTMLElement>
    onPlay ReactEventHandler<HTMLElement>
    onPlayCapture ReactEventHandler<HTMLElement>
    onPlaying ReactEventHandler<HTMLElement>
    onPlayingCapture ReactEventHandler<HTMLElement>
    onProgress ReactEventHandler<HTMLElement>
    onProgressCapture ReactEventHandler<HTMLElement>
    onRateChange ReactEventHandler<HTMLElement>
    onRateChangeCapture ReactEventHandler<HTMLElement>
    onSeeked ReactEventHandler<HTMLElement>
    onSeekedCapture ReactEventHandler<HTMLElement>
    onSeeking ReactEventHandler<HTMLElement>
    onSeekingCapture ReactEventHandler<HTMLElement>
    onStalled ReactEventHandler<HTMLElement>
    onStalledCapture ReactEventHandler<HTMLElement>
    onSuspend ReactEventHandler<HTMLElement>
    onSuspendCapture ReactEventHandler<HTMLElement>
    onTimeUpdate ReactEventHandler<HTMLElement>
    onTimeUpdateCapture ReactEventHandler<HTMLElement>
    onVolumeChange ReactEventHandler<HTMLElement>
    onVolumeChangeCapture ReactEventHandler<HTMLElement>
    onWaiting ReactEventHandler<HTMLElement>
    onWaitingCapture ReactEventHandler<HTMLElement>
    onAuxClick MouseEventHandler<HTMLElement>
    onAuxClickCapture MouseEventHandler<HTMLElement>
    onClick MouseEventHandler<HTMLElement>
    onClickCapture MouseEventHandler<HTMLElement>
    onContextMenu MouseEventHandler<HTMLElement>
    onContextMenuCapture MouseEventHandler<HTMLElement>
    onDoubleClick MouseEventHandler<HTMLElement>
    onDoubleClickCapture MouseEventHandler<HTMLElement>
    onDrag DragEventHandler<HTMLElement>
    onDragCapture DragEventHandler<HTMLElement>
    onDragEnd DragEventHandler<HTMLElement>
    onDragEndCapture DragEventHandler<HTMLElement>
    onDragEnter DragEventHandler<HTMLElement>
    onDragEnterCapture DragEventHandler<HTMLElement>
    onDragExit DragEventHandler<HTMLElement>
    onDragExitCapture DragEventHandler<HTMLElement>
    onDragLeave DragEventHandler<HTMLElement>
    onDragLeaveCapture DragEventHandler<HTMLElement>
    onDragOver DragEventHandler<HTMLElement>
    onDragOverCapture DragEventHandler<HTMLElement>
    onDragStart DragEventHandler<HTMLElement>
    onDragStartCapture DragEventHandler<HTMLElement>
    onDrop DragEventHandler<HTMLElement>
    onDropCapture DragEventHandler<HTMLElement>
    onMouseDown MouseEventHandler<HTMLElement>
    onMouseDownCapture MouseEventHandler<HTMLElement>
    onMouseEnter MouseEventHandler<HTMLElement>
    onMouseLeave MouseEventHandler<HTMLElement>
    onMouseMove MouseEventHandler<HTMLElement>
    onMouseMoveCapture MouseEventHandler<HTMLElement>
    onMouseOut MouseEventHandler<HTMLElement>
    onMouseOutCapture MouseEventHandler<HTMLElement>
    onMouseOver MouseEventHandler<HTMLElement>
    onMouseOverCapture MouseEventHandler<HTMLElement>
    onMouseUp MouseEventHandler<HTMLElement>
    onMouseUpCapture MouseEventHandler<HTMLElement>
    onSelect ReactEventHandler<HTMLElement>
    onSelectCapture ReactEventHandler<HTMLElement>
    onTouchCancel TouchEventHandler<HTMLElement>
    onTouchCancelCapture TouchEventHandler<HTMLElement>
    onTouchEnd TouchEventHandler<HTMLElement>
    onTouchEndCapture TouchEventHandler<HTMLElement>
    onTouchMove TouchEventHandler<HTMLElement>
    onTouchMoveCapture TouchEventHandler<HTMLElement>
    onTouchStart TouchEventHandler<HTMLElement>
    onTouchStartCapture TouchEventHandler<HTMLElement>
    onPointerDown PointerEventHandler<HTMLElement>
    onPointerDownCapture PointerEventHandler<HTMLElement>
    onPointerMove PointerEventHandler<HTMLElement>
    onPointerMoveCapture PointerEventHandler<HTMLElement>
    onPointerUp PointerEventHandler<HTMLElement>
    onPointerUpCapture PointerEventHandler<HTMLElement>
    onPointerCancel PointerEventHandler<HTMLElement>
    onPointerCancelCapture PointerEventHandler<HTMLElement>
    onPointerEnter PointerEventHandler<HTMLElement>
    onPointerEnterCapture PointerEventHandler<HTMLElement>
    onPointerLeave PointerEventHandler<HTMLElement>
    onPointerLeaveCapture PointerEventHandler<HTMLElement>
    onPointerOver PointerEventHandler<HTMLElement>
    onPointerOverCapture PointerEventHandler<HTMLElement>
    onPointerOut PointerEventHandler<HTMLElement>
    onPointerOutCapture PointerEventHandler<HTMLElement>
    onGotPointerCapture PointerEventHandler<HTMLElement>
    onGotPointerCaptureCapture PointerEventHandler<HTMLElement>
    onLostPointerCapture PointerEventHandler<HTMLElement>
    onLostPointerCaptureCapture PointerEventHandler<HTMLElement>
    onScroll UIEventHandler<HTMLElement>
    onScrollCapture UIEventHandler<HTMLElement>
    onWheel WheelEventHandler<HTMLElement>
    onWheelCapture WheelEventHandler<HTMLElement>
    onAnimationStart AnimationEventHandler<HTMLElement>
    onAnimationStartCapture AnimationEventHandler<HTMLElement>
    onAnimationEnd AnimationEventHandler<HTMLElement>
    onAnimationEndCapture AnimationEventHandler<HTMLElement>
    onAnimationIteration AnimationEventHandler<HTMLElement>
    onAnimationIterationCapture AnimationEventHandler<HTMLElement>
    onTransitionEnd TransitionEventHandler<HTMLElement>
    onTransitionEndCapture TransitionEventHandler<HTMLElement>
    pure 是否开启 Pure Render 模式,会提高性能,但是也会带来副作用 boolean
    warning 是否在开发模式下显示组件属性被废弃的 warning 提示 boolean
    rtl 是否开启 rtl 模式 boolean

    DocStructureArticle

    折叠样式文档组件。

    参数 说明 类型 可选值 默认值
    props (必填) 需要渲染的组件字段 WmProps

    DocStructurePropBlock

    折叠样式文档组件。

    参数 说明 类型 可选值 默认值
    prop (必填) 需要渲染的组件字段 WmPropItem

    DocStructureMarkdownRender

    Markdown展示

    参数 说明 类型 可选值 默认值
    className string
    allowDangerousHtml boolean
    skipHtml boolean
    disallowedTypes ("text" | "list" | "link" | "paragraph" | "heading" | "thematicBreak" | "blockquote" | "table" | "html" | "code" | "yaml" | "definition" | "footnoteDefinition" | "listItem" | "tableRow" | ... 10 more ... | "linkReference")[]
    escapeHtml @deprecated use allowDangerousHtml boolean
    allowedTypes ("text" | "list" | "link" | "paragraph" | "heading" | "thematicBreak" | "blockquote" | "table" | "html" | "code" | "yaml" | "definition" | "footnoteDefinition" | "listItem" | "tableRow" | ... 10 more ... | "linkReference")[]
    sourcePos boolean
    includeNodeIndex boolean
    rawSourcePos boolean
    allowNode (node: Content, index: number, parent: "text" | "list" | "link" | "paragraph" | "heading" | "thematicBreak" | "blockquote" | "table" | "html" | "code" | "yaml" | "definition" | ... 13 more ... | "linkReference") => boolean
    linkTarget string | LinkTargetResolver string, LinkTargetResolver
    transformLinkUri (uri: string, children?: ReactNode, title?: string) => string
    transformImageUri (uri: string, children?: ReactNode, title?: string, alt?: string) => string
    renderers { [nodeType: string]: ElementType<any>; }
    astPlugins PluggableList<Settings>
    plugins PluggableList<Settings>
    unwrapDisallowed boolean

    Install

    npm i whale-docgen-render

    DownloadsWeekly Downloads

    3

    Version

    0.1.6

    License

    MIT

    Unpacked Size

    5.12 MB

    Total Files

    96

    Last publish

    Collaborators

    • x_xsp