Skip to content


This function returns a property as a Ref given its dot-notated path. The path is typed, provided TypeScript support for global properties is set up properly.

This function is specifically useful to access global properties, but it can also access component properties.

RelatedsetProperty, useProperties


useProperty accepts a dot-notated path as its first parameter and returns a ComputedRef with the value at the given path.

const name = useProperty('security.user.full_name')

  title: () => `${name.value}'s profile`

Accessing view properties

While useProperty is primarily made for accessing typed, global properties, you may provide a custom generic type to opt-out of global type-checking if you need to access view-specific properties.

const posts = useProperty<App.Data.Post[]>('posts')