@workday/canvas-kit-react/dist/commonjs/collection/lib/useGridModel.js

The parent module that contains all Workday Canvas Kit React components

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.useGridModel = void 0;
const common_1 = require("@workday/canvas-kit-react/common");
const useCursorListModel_1 = require("./useCursorListModel");
const useListModel_1 = require("./useListModel");
const { columnCount, orientation, ...defaultConfig } = useListModel_1.useListModel.defaultConfig;
/**
 * The Grid model extends the `ListModel` and changes some config. For example, the `columnCount` is
 * required on the grid model's configuration and `orientation` is removed.
 */
exports.useGridModel = (0, common_1.createModelHook)({
    defaultConfig: {
        ...defaultConfig,
        /**
         * Controls the state changes when the user sends navigation events to the model. For example,
         * when the user hits the "right" arrow, a behavior hook will determine directionality
         * (left-to-right or right-to-left) and call the correct navigation method. In our example, a
         * left-to-right language would send a `getNext`. The navigation manager may return the next
         * item in the list. Different managers can be created for slightly different use cases. The
         * default navigation manager will stop when the end of a row/column is detected. For example,
         * `getNext` will return the same item the cursor was previously on if the cursor is on the last
         * item of a row.
         */
        navigation: useCursorListModel_1.navigationManager,
    },
    requiredConfig: {
        /**
         * The number of columns represented in a grid
         */
        columnCount: 1,
        ...useListModel_1.useListModel.requiredConfig,
    },
    contextOverride: useListModel_1.useListModel.Context,
})(config => {
    const list = (0, useListModel_1.useListModel)(config);
    return list;
});