useDocyrusKanban

Installation

pnpm dlx @docyrus/cli add @docyrus/rn-hooks-use-docyrus-kanban

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

This is a port of the web hook with the same signature. It builds on useDocyrusDataViewSelect for the schema and saved views. The items request uses the active view's filters and sort, the search keyword and listParams (whose filters are AND-merged with the view's filters). It returns a pre-wired toolbar and board. The board is the native Kanban in grouped-value mode.

Supported group fields: field-select, field-radioGroup, field-status, field-userSelect (one column per user or per team) and field-date / field-dateTime (bucketed by day, week or month; the time part is ignored).

Moving cards: long-press a card to drag it. The hook sends a single PATCH of the group field when you drop the card, never during the drag. Only enum and user columns can be changed this way. Date buckets and team columns are derived, so a card dropped there snaps back.

Usage

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

import { useDocyrusKanban } from '@/hooks/docyrus-native/use-docyrus-kanban';

export function TasksBoard() {
  const client = useDocyrusClient();

  const { toolbar, board } = useDocyrusKanban({
    client: client!,
    appSlug: 'base',
    dataSourceSlug: 'task',
    groupByFieldSlug: 'status',
    titleColumn: 'subject',
    descriptionColumn: 'description',
    userColumn: 'created_by',
    persistState: true,
    onCardOpen: row => router.push(`/tasks/${row.id}`),
    cardMenuItems: (row, defaults) => [
      { key: 'duplicate', label: 'Duplicate', icon: 'fal copy', onAction: duplicate },
      ...defaults
    ]
  });

  return (
    <ScrollView>
      {toolbar}
      {board}
    </ScrollView>
  );
}

API Reference

Options (UseDocyrusKanbanOptions<TData>)

Extends every useDocyrusDataViewSelect option (appId, staleTime, systemViews, persistKey, activeViewStorage, …).

DocyrusKanbanCardMenuItem

Result (UseDocyrusKanbanResult<TData>)

Exports

DOCYRUS_KANBAN_SUPPORTED_FIELD_TYPES (Set<string>) and readUserMeta(value, mode), which normalizes a user or team payload to { id, label, imageUrl }.

Native deltas

• The card ⋮ button (and the info icon) opens an action sheet with the menu items. The created / modified audit trail is the sheet message, where web uses a hover tooltip. label and icon are strings.
• Delete asks for confirmation in the native RecordDeleteConfirmDialog.
• If a move fails (the built-in PATCH rejects or onItemMoveCommit throws), the board returns to the server's distribution.
• The toolbar is stacked: start content and view picker, then search, then a horizontal row with the group pickers, "Show all", reload and end content.

Translation Keys

Type Exports