@zeix/ui-element
Version:
UIElement - a HTML-first library for reactive Web Components
58 lines (29 loc) • 873 B
Markdown
[**/ui-element**](../README.md)
***
[/ui-element](../globals.md) / read
# Function: read()
> **read**\<`Q`, `K`\>(`target`, `prop`, `fallback`): () => `Q`\[`K`\]
Defined in: [src/core/dom.ts:343](https://github.com/zeixcom/ui-element/blob/297c0e8e040b3880ad85a2bc873523a8086f09a3/src/core/dom.ts#L343)
Read a signal property from a custom element safely after it's defined
## Type Parameters
### Q
`Q` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
### K
`K` *extends* `string`
## Parameters
### target
Taget descendant element
`null` | [`Component`](../type-aliases/Component.md)\<`Q`\>
### prop
`K`
Property name to get signal for
### fallback
`Q`\[`K`\]
Fallback value to use until component is ready
## Returns
Function that returns signal value or fallback
> (): `Q`\[`K`\]
### Returns
`Q`\[`K`\]
## Since
0.13.1