Skip to content


Embedded hooks

In addition to our React Integration, Cozy Client comes with several hooks.

  • useAppLinkWithStoreFallback: Returns the URL of an app if this app is installed. If not, returns the URL to the store to install it.
  • useCapabilities: Returns the capabilities for an instance
  • useFetchShortcut: Returns the data for a shortcut
  • useClient: Returns client of actual context
  • useFetchJSON: Hook to use the generic fetchJSON method. Returns object with the same keys { data, fetchStatus, error } as useQuery
  • useQuery: Returns the queryState after fetching a queryDefinition
  • useSettings: Query the cozy-app settings corresponding to the given slug

Accessing and Mutating cozy-app settings with useSettings

Sometimes cozy-apps need to access settings related data

Those settings can be specific to the cozy-app, or global to the Cozy’s instance

In order to ease manipulating those settings we provide the hook useSettings

This hook is based on useQuery and useMutation to provide the setting’s values and a save method that allow to mutate the settings

Additionally, the query and mutation object are provided in order to react to their corresponding states (fetch status, mutation status, etc)

import { hasQueryBeenLoaded, useSettings } from 'cozy-client'

function DefaultRedirectionSetting() {
  const [inputValue, setInputValue] = useState('')

  const { values, save, query, mutation } = useSettings(
    'instance', // slug for acessing the global settings
    ['default_redirection'], // setting names

  const handleChange = event => {

  const handleBlur = () => {
      default_redirection: inputValue

  useEffect(() => {
  }, [values])

  return (
    <div style={{ display: 'flex' }}>
        style={{ marginRight: '1rem' }}
      {mutation.mutationStatus === 'loaded' ? '✓' : null}
      {mutation.mutationStatus === 'failed' ? '✗' : null}