Skip to content
On this page

Module: util/vue

Interfaces

Type Aliases

PropTypes

Ƭ PropTypes: typeof Boolean | typeof String | typeof Number | typeof Function | typeof Object | typeof Array

Defined in

profectus/src/util/vue.tsx:209

Functions

coerceComponent

coerceComponent(component, defaultWrapper?): DefineComponent

Parameters

NameTypeDefault value
componentCoercableComponentundefined
defaultWrapperstring"span"

Returns

DefineComponent


computeComponent

computeComponent(component, defaultWrapper?): ShallowRef<Component | "">

Parameters

NameTypeDefault value
componentRef<ProcessedComputable<CoercableComponent>>undefined
defaultWrapperstring"div"

Returns

ShallowRef<Component | "">


computeOptionalComponent

computeOptionalComponent(component, defaultWrapper?): ShallowRef<Component | "" | null>

Parameters

NameTypeDefault value
componentRef<ProcessedComputable<undefined | CoercableComponent>>undefined
defaultWrapperstring"div"

Returns

ShallowRef<Component | "" | null>


getFirstFeature

getFirstFeature<T>(features, filter): Object

Type parameters

NameType
Textends VueFeature & { visibility: ProcessedComputable<Visibility> }

Parameters

NameType
featuresT[]
filter(feature: T) => boolean

Returns

Object

NameType
collapsedContentJSXFunction
firstFeatureRef<T | undefined>
hasCollapsedContentRef<boolean>

isCoercableComponent

isCoercableComponent(component): component is CoercableComponent

Parameters

NameType
componentunknown

Returns

component is CoercableComponent


joinJSX

joinJSX(objects, joiner): JSX.Element

Parameters

NameType
objectsElement[]
joinerElement

Returns

JSX.Element


processedPropType

processedPropType<T>(...types): PropType<ProcessedComputable<T>>

Type parameters

Name
T

Parameters

NameType
...typesPropTypes[]

Returns

PropType<ProcessedComputable<T>>


render

render(object): JSX.Element | DefineComponent

Parameters

NameType
objectCoercableComponent | VueFeature

Returns

JSX.Element | DefineComponent


renderCol

renderCol(...objects): JSX.Element

Parameters

NameType
...objects(CoercableComponent | VueFeature)[]

Returns

JSX.Element


renderColJSX

renderColJSX(...objects): JSX.Element

Parameters

NameType
...objects(CoercableComponent | VueFeature)[]

Returns

JSX.Element


renderJSX

renderJSX(object): JSX.Element

Parameters

NameType
objectCoercableComponent | VueFeature

Returns

JSX.Element


renderRow

renderRow(...objects): JSX.Element

Parameters

NameType
...objects(CoercableComponent | VueFeature)[]

Returns

JSX.Element


renderRowJSX

renderRowJSX(...objects): JSX.Element

Parameters

NameType
...objects(CoercableComponent | VueFeature)[]

Returns

JSX.Element


setRefValue

setRefValue<T>(ref, value): void

Type parameters

Name
T

Parameters

NameType
refRef<T | Ref<T>>
valueT

Returns

void


setupHoldToClick

setupHoldToClick(onClick?, onHold?): Object

Parameters

NameType
onClick?Ref<undefined | (e?: MouseEvent | TouchEvent) => void>
onHold?Ref<undefined | VoidFunction>

Returns

Object

NameType
handleHoldingVoidFunction
start(e: MouseEvent | TouchEvent) => void
stopVoidFunction

trackHover

trackHover(element): Ref<boolean>

Parameters

NameType
elementVueFeature

Returns

Ref<boolean>


unwrapRef

unwrapRef<T>(ref): T

Type parameters

Name
T

Parameters

NameType
refRef<ProcessedComputable<T>>

Returns

T


wrapRef

wrapRef<T>(ref): ComputedRef<T>

Type parameters

Name
T

Parameters

NameType
refRef<ProcessedComputable<T>>

Returns

ComputedRef<T>