# Overview
URL: /docs/native/hooks

Reusable React Native hooks for Docyrus-connected mobile applications.

Browse all available Docyrus UI native hooks.

## Available Hooks

| Hook | Description |
|-----------|-------------|
| [useAdaptiveCard](/docs/native/hooks/use-adaptive-card) | Headless state, validation, visibility and action dispatch for the native Adaptive Cards renderer. Drives the AdaptiveCard component and is exported so apps can wire custom toolbars or server-side validation. |
| [useDataExport](/docs/native/hooks/use-data-export) | Client-side export of already-loaded rows to CSV, JSON, Markdown or Excel on React Native. Projects rows through a column list, writes the file into the cache directory and opens the share sheet. API-aligned with the web useDataExport. |
| [useDateFormat](/docs/native/hooks/use-date-format) | Provider-agnostic date, datetime and time formatting context for Docyrus native components. Wired automatically by DocyrusTenantProvider, but works with any date library. |
| [useDocyrusAdaptiveCardItemDetail](/docs/native/hooks/use-docyrus-adaptive-card-item-detail) | Generate an Adaptive Card JSON payload from a Docyrus field list + a single record — mapping Docyrus field types onto the Adaptive Cards element vocabulary — and render it with the shared native AdaptiveCard renderer. |
| [useDocyrusAdaptiveCardItemList](/docs/native/hooks/use-docyrus-adaptive-card-item-list) | Generate an array of Adaptive Card JSON payloads from a Docyrus field list + many records, and render them as a responsive grid, a stacked list, a single Carousel card or a single Table card with the shared native AdaptiveCard renderer. |
| [useDocyrusAgentAttachments](/docs/native/hooks/use-docyrus-agent-attachments) | Uploads chat attachments to a Docyrus agent thread (creating the thread on first use) and returns the storage paths for the chat request. |
| [useDocyrusAgentChat](/docs/native/hooks/use-docyrus-agent-chat) | The complete streaming chat runtime for a Docyrus AI agent — AI SDK transport, threads, attachment uploads and client-side tool execution — ready to drive DocyrusAgent. |
| [useDocyrusAgentInfo](/docs/native/hooks/use-docyrus-agent-info) | Fetches a Docyrus AI agent's profile, suggestions and capabilities from the agent-deployment endpoint and maps them onto the DocyrusAgent props. |
| [useDocyrusAgentMemories](/docs/native/hooks/use-docyrus-agent-memories) | Backend glue for the DocyrusAgent memory manager — list, create, update and delete /v1/ai/memories with optimistic local state. |
| [useDocyrusAgentMemoryCandidates](/docs/native/hooks/use-docyrus-agent-memory-candidates) | Backend glue for the DocyrusAgent memory-extraction dialog — extract candidates from a thread, then save or skip them. |
| [useDocyrusAgentProjects](/docs/native/hooks/use-docyrus-agent-projects) | Lists, creates, renames and deletes Docyrus AI projects scoped to an agent. |
| [useDocyrusAgentThreads](/docs/native/hooks/use-docyrus-agent-threads) | Lists, renames, deletes and loads the messages of Docyrus AI assistant chat threads. |
| [useDocyrusCalendar](/docs/native/hooks/use-docyrus-calendar) | Calendar backed by a Docyrus data source. Detects the date, title, color, description and user fields, turns records into events, and wires create, update, delete and drag to the API. |
| [useDocyrusContactActivity](/docs/native/hooks/use-docyrus-contact-activity) | Merges a record's audit log, comments, related events and tasks, and status updates into one typed timeline for ContactActivityPanel, with upcoming items, a relationship summary and comment and status mutations. |
| [useDocyrusContactChannels](/docs/native/hooks/use-docyrus-contact-channels) | React Query wiring for the Contact Channels & Consent API — a record's channels, consent and validation ledgers, tenant brands and every channel / consent / validation mutation. |
| [useDocyrusDataExport](/docs/native/hooks/use-docyrus-data-export) | Server-side export of a Docyrus data source on React Native. POSTs the column list, filters and keyword to the query-export endpoint, writes the returned xlsx or csv file into the cache directory and opens the share sheet. |
| [useDocyrusDataGallery](/docs/native/hooks/use-docyrus-data-gallery) | Docyrus-backed card gallery for React Native — composes useDocyrusDataGrid for schema, saved views, server filters / sort / search / paging and pivot / side filters, and adds gallery-owned card + display config, a toolbar and props for the native DataGallery. |
| [useDocyrusDataGrid](/docs/native/hooks/use-docyrus-data-grid) | Everything a Docyrus-backed native DataGrid needs in one hook — columns from the schema, server-side filters / sort / search / paging, saved views, pivot filters, advanced AND/OR filter, borrowed relation columns, inline edit, status updates, bulk actions, exports and persisted view parameters. |
| [useDocyrusDataImportWizard](/docs/native/hooks/use-docyrus-data-import-wizard) | One-call wiring of a Docyrus data source to the native DataImportWizard. Picks a spreadsheet, uploads and analyses it on the server, auto-maps columns, imports the rows and returns a ready-to-render wizard element plus imperative helpers. |
| [useDocyrusDataSourceFields](/docs/native/hooks/use-docyrus-data-source-fields) | Lightweight schema hook for one Docyrus data source on React Native. Returns the data source and its field list (including inline enum options), served cache-first from the shared inventory so no extra request is made after the post-sign-in warm-up. |
| [useDocyrusDataSourceJsonSchema](/docs/native/hooks/use-docyrus-data-source-json-schema) | Generate a JSON Schema (object schema, properties keyed by field slug) from a Docyrus data source field list. |
| [useDocyrusDataTable](/docs/native/hooks/use-docyrus-data-table) | Headless Docyrus-backed table for the native DataTable — schema columns rendered with the value renderers, server filters / sort / search / paging, saved views, bulk actions, exports and a table ↔ gallery view node. |
| [useDocyrusDataViewSelect](/docs/native/hooks/use-docyrus-data-view-select) | Load a Docyrus data source's fields, saved views and forms, and wire them into the native DataGridViewSelect with one hook — view CRUD, reorder, hidden views and persisted active view included. |
| [useDocyrusDummyDataGeneratorWizard](/docs/native/hooks/use-docyrus-dummy-data-generator-wizard) | One-call wiring of a Docyrus data source to the native DummyDataGenerator. Loads the schema, seeds per-field strategies, generates seeded sample rows, previews and exports them, and inserts them into the data source. Returns an inline wizard element plus imperative helpers. |
| [useDocyrusEmailComposer](/docs/native/hooks/use-docyrus-email-composer) | Wires the native EmailComposer to the Docyrus messaging API — sender accounts, @ mention users and the send mutation, with composer state managed for you. |
| [useDocyrusFieldComponent](/docs/native/hooks/use-docyrus-field-component) | Resolve the native form field, value renderer or inline editor for a Docyrus field type — plus the shared FORM_FIELD_MAP / VALUE_RENDERER_MAP registries and IField helpers. |
| [useDocyrusFormView](/docs/native/hooks/use-docyrus-form-view) | Create, edit and view forms bound to a Docyrus data source on React Native. Loads the schema, record and options, uploads files to Docyrus storage and creates or updates the record through the shared form-view engine. |
| [useDocyrusInstantMessageComposer](/docs/native/hooks/use-docyrus-instant-message-composer) | Wires the native InstantMessageComposer to the Docyrus SMS and WhatsApp messaging API. |
| [useDocyrusInventory](/docs/native/hooks/use-docyrus-inventory) | Shared app-utils inventory cache for Docyrus metadata (apps, data sources with fields, enums, views and forms, users, brands, preferences) plus a post-sign-in warm-up hook that drives a loading screen. |
| [useDocyrusKanban](/docs/native/hooks/use-docyrus-kanban) | Kanban board backed by a Docyrus data source. Groups records by an enum, user or date field, and saves a card's move to the API when it is dropped. Enum options marked final become drop zones. |
| [useDocyrusLogActivity](/docs/native/hooks/use-docyrus-log-activity) | Docyrus data engine for LogActivityForm. Fetches comments, users, task and event options and the record's status field, and runs the comment, task, event and two-call status mutations. |
| [useDocyrusMapView](/docs/native/hooks/use-docyrus-map-view) | Map backed by a Docyrus data source. Detects the location field and builds markers from logos, icons or the default pin, with clustering, a viewport filter, basemaps and drag-to-move with reverse geocoding. |
| [useDocyrusPivotCalendar](/docs/native/hooks/use-docyrus-pivot-calendar) | PivotCalendar backed by a Docyrus data source. Aggregates per day or month in the database through a pivot matrix, optionally grouped by a relation, and turns a tapped value into a ready-to-run drilldown query. |
| [useDocyrusPivotFilter](/docs/native/hooks/use-docyrus-pivot-filter) | Connects a Docyrus data source to a native PivotFilter strip. It detects the field type, runs a pivot aggregate query, builds pill items and date buckets, and emits filter rules. DocyrusPivotFilterGroup stacks several strips that cross-filter each other. |
| [useDocyrusPivotGrid](/docs/native/hooks/use-docyrus-pivot-grid) | Pivot grid backed by a Docyrus data source. Aggregates on the device from raw records, or in the database through a pivot matrix and calculations, and returns a controller for the native PivotGrid components. |
| [useDocyrusTenant](/docs/native/hooks/use-docyrus-tenant) | Tenant integration for Docyrus native apps. Fetches tenant preferences, builds dateUtils and numberUtils, and wires DateFormatProvider and NumberFormatProvider so every native component picks up the tenant's date and number formats. |
| [useDynamicFormView](/docs/native/hooks/use-dynamic-form-view) | Backend-agnostic form engine for React Native. Renders an IField schema with sections, tabs, collapsible panels, computed fields, field and form actions, validation tokens and a submit payload builder, with no network I/O. |
| [useLocalDataSource](/docs/native/hooks/use-local-data-source) | Create an in-memory Docyrus-compatible data source from a JSON array, with local CRUD and Docyrus-style query parameters. |
| [useLocalDataSourceDataGrid](/docs/native/hooks/use-local-data-source-data-grid) | Run the full useDocyrusDataGrid workflow — views, search, filters, grouping, sort, inline save, bulk delete — over an in-memory LocalDataSource. No backend, no sign-in. |
| [useNumberFormat](/docs/native/hooks/use-number-format) | Provider-agnostic number formatting context for Docyrus native components. Mirror of useDateFormat, wired automatically by DocyrusTenantProvider. |
| [useParameterPersistence](/docs/native/hooks/use-parameter-persistence) | Persist a serializable view-parameter snapshot (search, filters, sort, column layout, …) per saved view and restore it on the next mount, backed by a synchronous native key-value store. |
| [useSpeechRecognition](/docs/native/hooks/use-speech-recognition) | Live speech-to-text for React Native with the same API as the web hook, backed by the optional expo-speech-recognition module. |
| [useUiTranslation](/docs/native/hooks/use-ui-translation) | Provider-agnostic i18n bridge for Docyrus native components. Same ui.`<group>`.`<key>` keys as the web package, English fallback when no provider is mounted. |