useDocyrusDataViewSelect

Installation

pnpm dlx @docyrus/cli add @docyrus/rn-hooks-use-docyrus-data-view-select

pnpm add @docyrus/app-utils @docyrus/api-client @tanstack/react-query @react-querybuilder/core

A 1:1 port of the web hook (same options, same result). It needs an authenticated RestApiClient and a QueryClientProvider above it. Schema, saved views and forms are served from the shared inventory cache (useDocyrusInventoryLoader), so a warmed app pays no per-mount request.

Overview

• Loads the data source (cache-first, then a scoped getBySlug with expand for data sources outside the inventory) and maps its fields to query-builder FullFields — enum / status / select options become values, relation fields get their first 200 records (id, name, autonumber_id) as picker values.
• Loads saved views (createDataViewClient) sorted by sort_order then name, prepends developer-defined systemViews, and wires create / save / delete / reorder with list invalidation (reorder is optimistic, one PATCH per moved view).
• Loads active forms (createDataFormClient), default form first, so the view editor can bind a form to each view.
• Owns the active view: current selection → persisted id → backend isDefault → first view.
• Keeps a per-user hidden views list (onViewHide / onViewUnhide).

Usage

import { useDocyrusClient } from '@docyrus/signin/react-native';

import { DataGridViewSelect } from '@/components/docyrus-native/data-grid-view-select';
import { useDocyrusDataViewSelect } from '@/hooks/docyrus-native/use-docyrus-data-view-select';

export function OrganizationViews({ table }) {
  const client = useDocyrusClient();
  const { gridViewSelectProps, hasNoViews } = useDocyrusDataViewSelect({
    client: client!,
    appSlug: 'base',
    dataSourceSlug: 'organization'
  });

  return (
    <DataGridViewSelect
      table={table}
      variant="horizontal-tabs"
      editable
      {...gridViewSelectProps} />
  );
}

The hook does not take table — spread gridViewSelectProps and pass table separately. useDocyrusDataGrid and useDocyrusDataTable call this hook for you.

API Reference

Options (UseDocyrusDataViewSelectOptions)

Result (UseDocyrusDataViewSelectResult)

How It Works

View shape mapping

Active view & persistence

The id is persisted under persistKey in the lib/storage store picked by activeViewStorage ('local' = the store registered through <DocyStorageProvider> / setDocyLocalStore(); 'session' = in-memory for the app process). With persistState on a data-listing hook, the key becomes docyrus:view-params:<appSlug>:<dataSourceSlug>[:<appId>]:__active-view__. The hidden-views list always lives in the 'local' store under docyrus:data-grid-view-hidden:<appSlug>:<dataSourceSlug>[:<appId>].

Native deltas

• FullField comes from @react-querybuilder/core (no DOM react-querybuilder).
• Storage goes through lib/storage (getDocyStore('local') / getPersistStore) instead of window.localStorage / sessionStorage. Register a synchronous persistent store (e.g. expo-sqlite/kv-store) to survive restarts.
• The "no saved view" warning is gated on __DEV__.

Type Exports