@olenbetong/react-data-object-connect
React HOC used to give a React component data from an Appframe data object
Last updated 8 hours ago by bjornarvh .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @olenbetong/react-data-object-connect 
SYNC missed versions from official npm registry.

React Data Object Connect

Utilities to connect AppframeWeb data objects to React components. Higher order components for class components, and hooks for function components.

Getting Started

Installation

Install using npm

npm install @olenbetong/react-data-object-connect

or include the IIFE build in a script (example uses hooks only build)

<script src="https://unpkg.com/@olenbetong/react-data-object-connect@4.7.0/dist/iife/dataObjectHooks.min.js"></script>

Hooks or connect/connectRow?

This package provides 2 primary ways of connecting React components to Appframe data objects: the connect/connectRow HoC components, and hooks. connect/connectRow provide most of the state from the data objects, while with hooks you might need to use several hooks to get the information you need.

Not sure if you should use the connect/connectRow functions, or the hooks? If you are using a React version > 16.8, it is recommended to only use the hooks, as they are more flexible, and usually result in smaller bundles.

Hooks

If using a React with hooks, there are also data object hooks available.

  • useCurrentIndex(dataObject) - Returns only the current index
  • useCurrentRow(dataObject) - Returns the current record
  • useData(dataObject, options) - Returns an array with all records currently in the data object
  • useDataLength(dataObject) - Returns the current number of records in the data object
  • useDataWithFilter(dataObject, filter, type) - Like useData, but loads data with the given filter.
  • useDirty(dataObject) - Returns a boolean indicating if the current row is dirty or not
  • useError(dataObject) - Returns any loading error message
  • useFilter(dataObject, filter, type) - Refreshes data object whenever the filter changes
  • useLoading(dataObject) - Returns a boolean indicating if the data object is loading or not
  • useStatus(dataObject) - Returns booleans indicating if the data object is saving or deleting records
  • usePaging(dataObject) - Returns page, page count and a method to change the page
  • useParameter(dataObject, parameter) - Returns the current value of parameter
  • usePermissions(dataObject) - Returns booleans indicating if the user can delete, insert or update records

The above hooks uses the data objects internal state to pass data to the components. If you do not want to depend on the data objects current row or data storage, you can use the following hooks. They return data from the data object's data handler directly, and will not affect the data objects internal state.

  • useFetchData(dataObject, filter) - Returns data matching the filter. If the filter is set to false, data will not be loaded.
  • useFetchRecord(dataObject, filter) - Use if the filter is expected to only return a single row. If multiple rows are returned from the server, only the first record will be returned to the component.

One hook is also available for procedures.

  • useProcedure(procedure, parameters, options) - Returns an object containing data, execute, isExecuting and error properties. Executes whenever the procedure or parameters arguments change. execute can be used to manually execute the procedure again

useData options

useData accepts a second options argument. Available options are:

  • includeDirty (default true) - Includes currently dirty data in the dataset. Disable this to optimize if the data is used many places.

Examples

Getting all state from the data object

This will list all reacords in the data object, and create an editor for the current row.

import {
  useCurrentIndex,
  useCurrentRow,
  useData,
  useDataLength,
  useDirty,
  useError,
  useLoading,
  useStatus,
  usePermissions,
  useParameter,
} from "@olenbetong/react-data-object-connect";

function MyFunctionComponent(props) {
  const currentIndex = useCurrentIndex(dsMyDataObject);
  const myRecord = useCurrentRow(dsMyDataObject);
  const myRecords = useData(dsMyDataObject);
  const count = useDataLength(dsMyDataObject);
  const isDirty = useDirty(dsMyDataObject);
  const error = useError(dsMyDataObject);
  const isLoading = useLoading(dsMyDataObject);
  const { isDeleting, isSaving } = useStatus(dsMyDataObject);
  const { allowDelete, allowInsert, allowUpdate } = usePermissions(dsMyDataObject);
  const filter = useParameter(dsMyDataObject, "filterString");

  return (
    <div>
      {isLoading && <i className="fa fa-spin fa-spinner" />}
      {error && <Error message={error} />}
      <MyEditor {...myRecord} isDirty={isDirty} />
      {myRecords.map(record => (
        <ListItem {...item} />
      ))}
      There are {count} records matching {filter}
    </div>
  );
}

Automatically getting data with a given filter.

If you want to conditionally load data, you may set the filter to false.

import { useDataWithFilter, useLoading } from "@olenbetong/react-data-object-connect";

function MyComponent({ someId }) {
  const isLoading = useLoading(dsMyDataObject);
  const data = useDataWithFilter(dsMyDataObject, `[SomeID] = ${someId}`);

  return (
    <div>
      {isLoading && <i className="fa fa-spin fa-spinner" />}
      {data.map(record => (
        <ListItem {...record} />
      ))}
    </div>
  );
}

Getting data from the data source without affecting the data object

If you want to conditionally load data, you may set the filter to false.

The refreshRows method can be used to update only a subset of the current data. The first parameter is the filter that will be used to fetch data. The second parameter is the field that will be used to compare fetched data with current data (defaults to PrimKey). If the refreshRows fetches records that are not in the current set, they will not be added.

import { useFetchData, useFetchRecord } from "@olenbetong/react-data-object-connect";

function MyFunctionComponent(props) {
  const { isLoading, data, refresh, refreshRows } = useFetchData(dsMyDataObject, `[EntityCategory] = 1`);

  return (
    <div>
      {isLoading && <i className="fa fa-spin fa-spinner" />}
      {data.map(data => (
        <ListItem {...item} onRefresh={refreshRows(`[PrimKey] = '${item.PrimKey}'`, "PrimKey")} />
      ))}
    </div>
  );
}

function MyRecordComponent(props) {
  const { isLoading, record, refresh } = useFetchRecord(dsMyDataObject, `[EntityID] = ${props.id}`);

  return (
    <div>
      {isLoading && <Spinner />}
      <button onClick={refresh}>
        <i className="fa fa-refresh" /> Refresh
      </button>
      <MyEditor {...record} />
    </div>
  );
}

Executing a stored procedure

If 'Parameter', 'OtherParam', 'ThirdParam' are not valid parameters for 'procMyProcedure', they will be removed before executing the procedure. This way the procedure can be executed even if the actual parameters haven't changed. If 'removeInvalidParameters' isn't set to true, an error will occur instead.

import { useProcedure } from "@olenbetong/react-data-object-connect";

function MyComponent() {
  const { data, execute, error, isExecuting } = useProcedure(
    procMyProcedure,
    {
      Parameter: "value",
      OtherParam: 52,
      ThirdParam: "Oh, hai!",
    },
    { removeInvalidParameters: true }
  );

  return (
    <div>
      <button onClick={execute}>Refresh data</button>
      {error && <div className="alert alert-danger">{error}</div>}
      {isExecuting && <Spinner />}
      {data && data.length > 0 && data[0].map(record => <RecordComponent key={record.IdentityField} {...record} />)}
    </div>
  );
}

Paging component

import { usePaging } from "@olenbetong/react-data-object-connect";

function PagingComponent() {
  const { changePage, page, pagecount } = usePaging(dsMyDataObject);

  return (
    <div>
      <button onClick={() => changePage(page - 1)} disabled={page <= 0}>
        Previous
      </button>
      Page {page + 1} of {pageCount}
      <button onClick={() => changePage(page + 1)} disabled={page + 1 >= pageCount}>
        pagecount
      </button>
    </div>
  );
}

connect/connectRow

Use the connect and connectRow functions to create a higher order component that can be used to connect the data object to React components.

The connect function will pass all records to the component in a property named data, while the connectRow passes all the fields in the current row as properties to the component.

Example connecting to all records:

import React from "react";
import { connect } from "@olenbetong/react-data-object-connect";

const MyListComponent = props => (
  <ul>
    {props.data.map(item => (
      <li key={item.PrimKey}>{item.Title}</li>
    ))}
  </ul>
);

const MyConnectedList = connect(dsMyDataObject)(MyListComponent);

Example connecting to a single record, and checking if it is modified:

import React from 'react';
import { connectRow } from '@olenbetong/react-data-object-connect';

const MyRecordComponent = (props) => (
  <p>
    {props.isDirty && <div>(Data not saved</div>)}
    {props.Title}
  </p>
)

const MyConnectedComponent = connectRow(dsMyDataObject)(MyRecordComponent);

Properties

Status properties passed to the component:

  • canDelete (bool) whether the data object allows deleting rows
  • canUpdate (bool) whether the data object allows updating rows
  • canInsert (bool) whether the data object allows inserting rows
  • currentIndex (int) current index selected
  • isDirty (bool) whether the currently selectec row has been modified
  • isDeleting (bool) whether the data object is currently deleting a row
  • isLoading (bool) whether the data object is currently loading data
  • isSaving (bool) whether the data object is currently saving a record
  • loadError (string) error message if the data failed to load

Function properties passed to the component:

  • onCancelEdit used to cancel all changes made to the current record
  • onCurrentIndexChange used to select a row by index
  • onEndEdit used to attempt to save changes made to the current record
  • onDeleteRow used to delete a row. A component connected to the current row will always delete the current row, otherwise an index can be passed
  • onFieldChange used to update a field in the current row (name of field and value as parameters)
  • onFieldsChange used to update multiple fields in the current row (object with field names as keys, and values as values)
  • onRefreshData used to refresh data
  • onRefreshRow used to refresh only the current row
  • onSetParameter used to set a parameter on the data object

Reducing script size

Modules

If you use a bundler that supports tree shaking (webpack/rollup/parcel etc.), no further actions should be needed to reduce bundle size.

In the node package, the scripts are located in the es folder, and you can include the parts you need instead of the whole package.

For example, if you only use the useData hook, import it like this:

import useData from "@olenbetong/react-data-object-connect/es/useData";

Or for the connect/connectRow functions:

import { connect, connectRow } from "@olenbetong/react-data-object-connect/es/connect";

Browser

In the dist/iife there are a few files you can choose to add. If you only need hooks, use dataObjectHooks.min.js, which exports all the hooks in global variable dataObjectHooks. dataObjectConnect.min.js exports the connect and connectRow functions in global variable dataObjectConnect.

Changelog

See the GitHub releases page

Current Tags

  • 4.9.2                                ...           latest (8 hours ago)
  • 4.7.0-alpha.1                                ...           next (6 months ago)

42 Versions

  • 4.9.2                                ...           8 hours ago
  • 4.9.1                                ...           a day ago
  • 4.9.0                                ...           3 months ago
  • 4.8.2                                ...           5 months ago
  • 4.8.1                                ...           5 months ago
  • 4.8.0                                ...           5 months ago
  • 4.7.0                                ...           6 months ago
  • 4.7.0-alpha.1                                ...           6 months ago
  • 4.7.0-alpha.0                                ...           6 months ago
  • 4.6.0                                ...           6 months ago
  • 4.5.1                                ...           6 months ago
  • 4.5.0                                ...           6 months ago
  • 4.4.0                                ...           6 months ago
  • 4.3.1                                ...           7 months ago
  • 4.3.0                                ...           7 months ago
  • 4.2.0                                ...           7 months ago
  • 4.1.0                                ...           7 months ago
  • 4.0.6                                ...           8 months ago
  • 4.0.5                                ...           8 months ago
  • 4.0.4                                ...           8 months ago
  • 4.0.3                                ...           9 months ago
  • 4.0.2                                ...           9 months ago
  • 4.0.1                                ...           9 months ago
  • 4.0.0                                ...           10 months ago
  • 3.0.1                                ...           a year ago
  • 3.0.0                                ...           a year ago
  • 3.0.0-alpha.2                                ...           a year ago
  • 3.0.0-alpha.1                                ...           a year ago
  • 3.0.0-rc.1                                ...           a year ago
  • 2.1.6                                ...           a year ago
  • 2.1.5                                ...           a year ago
  • 2.1.4                                ...           a year ago
  • 2.1.3                                ...           a year ago
  • 2.1.2                                ...           a year ago
  • 2.1.1                                ...           a year ago
  • 2.1.0                                ...           a year ago
  • 2.0.1                                ...           a year ago
  • 2.0.0                                ...           a year ago
  • 1.1.0                                ...           a year ago
  • 1.0.2                                ...           a year ago
  • 1.0.1                                ...           a year ago
  • 1.0.0                                ...           a year ago

Copyright 2014 - 2016 © taobao.org |