# @blaze-cms/plugin-data-ui

> Blaze plugin data ui

Latest version **0.145.0** (published 2024-07-31) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @blaze-cms/plugin-data-ui
pnpm add @blaze-cms/plugin-data-ui
yarn add @blaze-cms/plugin-data-ui
bun add @blaze-cms/plugin-data-ui
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.145.0 |
| Published | 2024-07-31 |
| First published | 2019-07-10 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 26 |
| Unpacked size | 922.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Byte9 |
| Maintainers | ismael_haytam, emcleandev, tanane, daoyong, marekb9, mcabrerapf, jan_byte9, grzegorzi, andypail, ishrat, adrdilauro |

## Links

- npm: https://www.npmjs.com/package/@blaze-cms/plugin-data-ui
- npm.io page: https://npm.io/package/@blaze-cms/plugin-data-ui

## Dependencies (26)

- [uuid](https://npm.io/package/uuid.md) ^3.3.3
- [core-js](https://npm.io/package/core-js.md) ^3.2.1
- [lodash.has](https://npm.io/package/lodash.has.md) ^4.5.2
- [lodash.omit](https://npm.io/package/lodash.omit.md) ^4.5.0
- [react-helmet](https://npm.io/package/react-helmet.md) ^6.1.0
- [lodash.isempty](https://npm.io/package/lodash.isempty.md) ^4.4.0
- [lodash.isequal](https://npm.io/package/lodash.isequal.md) ^4.5.0
- [lodash.unionby](https://npm.io/package/lodash.unionby.md) ^4.8.0
- [@blaze-react/more](https://npm.io/package/@blaze-react/more.md) 0.5.19
- [lodash.upperfirst](https://npm.io/package/lodash.upperfirst.md) ^4.3.1
- [@blaze-react/table](https://npm.io/package/@blaze-react/table.md) 0.8.0-alpha.74
- [@blaze-react/utils](https://npm.io/package/@blaze-react/utils.md) 0.5.15
- [@blaze-cms/setup-ui](https://npm.io/package/@blaze-cms/setup-ui.md) ^0.140.3
- [@blaze-react/button](https://npm.io/package/@blaze-react/button.md) 0.5.19
- [@blaze-react/select](https://npm.io/package/@blaze-react/select.md) 0.8.0-alpha.64
- [regenerator-runtime](https://npm.io/package/regenerator-runtime.md) ^0.13.3
- [@blaze-react/toaster](https://npm.io/package/@blaze-react/toaster.md) 0.5.17
- [lodash.differencewith](https://npm.io/package/lodash.differencewith.md) ^4.5.0
- [@blaze-cms/core-errors](https://npm.io/package/@blaze-cms/core-errors.md) ^0.140.3
- [@blaze-react/pagination](https://npm.io/package/@blaze-react/pagination.md) 0.8.0-alpha.76
- [@blaze-cms/versioning-ui](https://npm.io/package/@blaze-cms/versioning-ui.md) ^0.140.3
- [@blaze-react/multiselect](https://npm.io/package/@blaze-react/multiselect.md) 0.8.0-alpha.78
- [@blaze-cms/admin-ui-utils](https://npm.io/package/@blaze-cms/admin-ui-utils.md) ^0.141.0
- [@blaze-cms/react-form-builder](https://npm.io/package/@blaze-cms/react-form-builder.md) ^0.141.0
- [@blaze-cms/react-page-builder](https://npm.io/package/@blaze-cms/react-page-builder.md) ^0.145.0
- [@blaze-cms/plugin-render-hooks-ui](https://npm.io/package/@blaze-cms/plugin-render-hooks-ui.md) ^0.140.3

## Recent versions

- 0.145.0 (latest) — 2024-07-31
- 0.146.0-rc-eagle-3.11 (rc-eagle-3) — 2026-09-21
- 1.1.0-alpha-q1-2026.9 (alpha-q1-2026) — 2026-09-17
- 0.146.0-node18-tooltips.56 (node18-tooltips) — 2026-09-04
- 0.147.0-rc-eagle.6 (rc-eagle) — 2026-07-10
- 0.146.0-node18-core-styles-tooltips.60 (node18-core-styles-tooltips) — 2026-06-18
- 0.146.0-translations.13 (translations) — 2025-11-25
- 0.146.0-alpha.69 (alpha) — 2025-09-22
- 0.146.0-core-styles.67 (core-styles) — 2025-08-21
- 0.146.0-node18-core-styles.3 (node18-core-styles) — 2025-05-19
- 0.146.0-tooltips.9 (tooltips) — 2025-04-07
- 0.146.0-node18.1 (node18) — 2025-03-25
- 0.141.0-core-variants.0 (core-variants) — 2024-03-26
- 0.139.0-project-admin-customisations.0 (project-admin-customisations) — 2024-01-03
- 0.135.0-admin-updates.2 (admin-updates) — 2023-11-21
- … 955 more at https://npm.io/package/@blaze-cms/plugin-data-ui/versions

## README

# Base Blaze plugin

Base files for a plugin

### Events emitted
| key                    | Description                                       | Argument                                       |
| ---------------------- | ------------------------------------------------- | ---------------------------------------------- |
| load:custom:field:type | Add to the form builder lookup a new custom field | {type: 'text': component: unmountendComponent} |



## displayProperties

The `displayProperties` property can be set on entity schema in the api to provide extra information for how to format the way an entity is display. For example the following could be set on an entity
```json
"displayProperties": {
    "adminHeader": [
      "firstname",
      "lastname"
    ],
    "adminLabel": {
      "main": [
        "firstname",
        "lastname"
      ],
      "sub": [
        "group.name"
      ]
    },
    "adminDefaultListingFilter": {
      "firstname": {
        "_exists": false
      }
    }
  }
```

- adminDefaultListingFilter: this is a where query that will be passed to the api to filter records from the admin listing
- adminLabel: properties to build label when record is showing search listings
- adminHeader: properties to build admin header
- adminMainInfoProperty: indicates a property that returns data to be displayed in the admin edit sidebar. Data is returned is formatted with the [data/info-properties](#Info properties) definition
- disableDefaultAdminInfo: boolean value that can be used to hide default sidebar values updated/created


### Info properties

There are a few places in the admin that render simple data in a specified format that can be configured on an entity schema as described above.

These properties return data in a format defined by the [data/info-properties](../blaze-plugin-data/src/schemas/definitions/info-properties.json) definition so that they have a consistent format. This defines the data should be and array of objects with following properties
- label: item label
- value: item value
- url: if set it will add a link around the value
- showLabel: indicates if the label should render, default is true

## Menu custom config

```js

import { DataIcon, EnquiryIcon, PluginIcon, UserIcon } from './components/menu-icons';
import coreAdminPlugin from '@blaze-cms/plugin-admin-core-ui';

 config.plugins.set(coreAdminPlugin, {
    menuConfig: {
      main: {
        items: {
          enquiries: {
            order: 11, // set order to set above plugin/user
            icon: EnquiryIcon,
            uri: '/data-listing/enquiry',
            label: 'Enquiry',
            items: {}
          },
          data: {
            order: 12, // set order to set above plugin/user
            label: 'Data',
            icon: DataIcon,
            items: {}
          },
          users: {
            order: 13, // set order to set above plugin/user
            label: 'Users',
            icon: UserIcon,
            items: {}
          },
          plugins: {
            order: 14,
            icon: PluginIcon,
            label: 'Plugins',
            items: {}
          }
        }
      }
    }
  });
```

---
_Source: https://npm.io/package/@blaze-cms/plugin-data-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
