Lawtext core references / core/src/renderer/common/docx/component

core/src/renderer/common/docx/component

Interfaces

Type Aliases

ComponentWithTag()<TTag>

ComponentWithTag<TTag>: <P>(props) => DOMElement<P & object, Element>

Defined in: core/src/renderer/common/docx/component.tsx:80 (opens in a new tab)

Type Parameters

• TTag extends string

Type declaration

Type Parameters

• P

Parameters

props

PropsWithChildren<P>

Returns

DOMElement<P & object, Element>

displayName

displayName: `ComponentWithTag<${TTag}>`

DOCXFigData

DOCXFigData: DOCXFigDataImage | DOCXFigDataEmbeddedPDF | DOCXFigDataRenderedPDF | DOCXFigDataEmbeddedAndRenderedPDF

Defined in: core/src/renderer/common/docx/component.tsx:52 (opens in a new tab)

Variables

DOCXMargin

const DOCXMargin: "　" = "　"

Defined in: core/src/renderer/common/docx/component.tsx:3 (opens in a new tab)

Functions

makeComponentWithTag()

makeComponentWithTag<TTag>(tag): ComponentWithTag<TTag>

Defined in: core/src/renderer/common/docx/component.tsx:87 (opens in a new tab)

Type Parameters

• TTag extends string

Parameters

tag

TTag

Returns

ComponentWithTag<TTag>

Relationships()

Relationships(props): ReactNode | Promise<ReactNode>

Defined in: core/src/renderer/common/docx/component.tsx:98 (opens in a new tab)

Parameters

props

relationships

object[]

Returns

ReactNode | Promise<ReactNode>

Types()

Types(props): ReactNode | Promise<ReactNode>

Defined in: core/src/renderer/common/docx/component.tsx:108 (opens in a new tab)

Parameters

props

types

({ ContentType: string; Extension: string; tag: "Default"; } | { ContentType: string; PartName: string; tag: "Override"; })[]

Returns

ReactNode | Promise<ReactNode>

wrapDOCXComponent()

wrapDOCXComponent<P, TComponentID>(docxComponentID, Component): FC<P & DOCXComponentProps> & object

Defined in: core/src/renderer/common/docx/component.tsx:71 (opens in a new tab)

Type Parameters

• P

• TComponentID extends string

Parameters

docxComponentID

TComponentID

Component

ComponentType<P & DOCXComponentProps>

Returns

FC<P & DOCXComponentProps> & object

Readme Docxcomponentprops