Module: util/vue
Type aliases
PropTypes
Ƭ PropTypes: typeof Boolean | typeof String | typeof Number | typeof Function | typeof Object | typeof Array
Defined in
profectus/src/util/vue.tsx:199
VueFeature
Ƭ VueFeature: Object
Type declaration
| Name | Type |
|---|---|
[Component] | GenericComponent |
[GatherProps] | () => Record<string, unknown> |
Defined in
Functions
coerceComponent
▸ coerceComponent(component, defaultWrapper?): DefineComponent
Parameters
| Name | Type | Default value |
|---|---|---|
component | CoercableComponent | undefined |
defaultWrapper | string | "span" |
Returns
DefineComponent
Defined in
computeComponent
▸ computeComponent(component, defaultWrapper?): ShallowRef<Component | "">
Parameters
| Name | Type | Default value |
|---|---|---|
component | Ref<ProcessedComputable<CoercableComponent>> | undefined |
defaultWrapper | string | "div" |
Returns
ShallowRef<Component | "">
Defined in
profectus/src/util/vue.tsx:161
computeOptionalComponent
▸ computeOptionalComponent(component, defaultWrapper?): ShallowRef<Component | "" | null>
Parameters
| Name | Type | Default value |
|---|---|---|
component | Ref<ProcessedComputable<undefined | CoercableComponent>> | undefined |
defaultWrapper | string | "div" |
Returns
ShallowRef<Component | "" | null>
Defined in
profectus/src/util/vue.tsx:171
getFirstFeature
▸ getFirstFeature<T>(features, filter): Object
Type parameters
| Name | Type |
|---|---|
T | extends VueFeature & { visibility: ProcessedComputable<Visibility> } |
Parameters
| Name | Type |
|---|---|
features | T[] |
filter | (feature: T) => boolean |
Returns
Object
| Name | Type |
|---|---|
collapsedContent | JSXFunction |
firstFeature | Ref<T | undefined> |
hasCollapsedContent | Ref<boolean> |
Defined in
profectus/src/util/vue.tsx:139
isCoercableComponent
▸ isCoercableComponent(component): component is CoercableComponent
Parameters
| Name | Type |
|---|---|
component | unknown |
Returns
component is CoercableComponent
Defined in
processedPropType
▸ processedPropType<T>(...types): PropType<ProcessedComputable<T>>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
...types | PropTypes[] |
Returns
PropType<ProcessedComputable<T>>
Defined in
profectus/src/util/vue.tsx:208
render
▸ render(object): JSX.Element | DefineComponent
Parameters
| Name | Type |
|---|---|
object | CoercableComponent | VueFeature |
Returns
JSX.Element | DefineComponent
Defined in
renderCol
▸ renderCol(...objects): JSX.Element
Parameters
| Name | Type |
|---|---|
...objects | (CoercableComponent | VueFeature)[] |
Returns
JSX.Element
Defined in
renderColJSX
▸ renderColJSX(...objects): JSX.Element
Parameters
| Name | Type |
|---|---|
...objects | (CoercableComponent | VueFeature)[] |
Returns
JSX.Element
Defined in
renderJSX
▸ renderJSX(object): JSX.Element
Parameters
| Name | Type |
|---|---|
object | CoercableComponent | VueFeature |
Returns
JSX.Element
Defined in
renderRow
▸ renderRow(...objects): JSX.Element
Parameters
| Name | Type |
|---|---|
...objects | (CoercableComponent | VueFeature)[] |
Returns
JSX.Element
Defined in
renderRowJSX
▸ renderRowJSX(...objects): JSX.Element
Parameters
| Name | Type |
|---|---|
...objects | (CoercableComponent | VueFeature)[] |
Returns
JSX.Element
Defined in
setRefValue
▸ setRefValue<T>(ref, value): void
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
ref | Ref<T | Ref<T>> |
value | T |
Returns
void
Defined in
profectus/src/util/vue.tsx:191
setupHoldToClick
▸ setupHoldToClick(onClick?, onHold?): Object
Parameters
| Name | Type |
|---|---|
onClick? | Ref<undefined | (e?: MouseEvent | TouchEvent) => void> |
onHold? | Ref<undefined | VoidFunction> |
Returns
Object
| Name | Type |
|---|---|
handleHolding | VoidFunction |
stop | VoidFunction |
start | (e: MouseEvent | TouchEvent) => void |
Defined in
profectus/src/util/vue.tsx:103
unwrapRef
▸ unwrapRef<T>(ref): T
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
ref | Ref<ProcessedComputable<T>> |
Returns
T
Defined in
profectus/src/util/vue.tsx:187
wrapRef
▸ wrapRef<T>(ref): ComputedRef<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
ref | Ref<ProcessedComputable<T>> |
Returns
ComputedRef<T>