next-ant-fields

Ant table column for next.

installation

yarn add @jswork/next-ant-fields

usage

import '@jswork/next-ant-fields';

// for string array
const fields1 = nx.antFields(['name', 'age', 'address']);
// fields1 will be like:
// [
//   { key: 'name', dataIndex: 'name', title: 'Name' },
//   { key: 'age', dataIndex: 'age', title: 'Age' },
//   { key: 'address', dataIndex: 'address', title: 'Address' }
// ]

// for object array
const fields2 = nx.antFields([
  { dataIndex: 'name', title: '姓名' },
  { dataIndex: 'age' },
  'address'
]);
// fields2 will be like:
// [
//   { dataIndex: 'name', title: '姓名', key: 'name' },
//   { dataIndex: 'age', title: 'Age', key: 'age' },
//   { dataIndex: 'address', title: 'Address', key: 'address' }
// ]

// with language option
// 1. setup language locales in config
nx.set(nx, 'cfg.next-ant-fields-schema', {
  language: 'zh-CN',
  defaults: {
    title: '标题',
    name: '姓名',
    age: '年龄'
  },
  locales: {
    'zh-CN': {
      title: '标题',
      name: '姓名',
      age: '年龄'
    },
    'en-US': {
      title: 'Title',
      name: 'Name',
      age: 'Age'
    }
  }
});

// 2. use default language from config (language)
const fields3 = nx.antFields(['title', 'name', 'age']);
// fields3 will be like:
// [
//   { key: 'title', dataIndex: 'title', title: '标题' },
//   { key: 'name', dataIndex: 'name', title: '姓名' },
//   { key: 'age', dataIndex: 'age', title: '年龄' }
// ]

// 3. specify language explicitly
const fields4 = nx.antFields(['title', 'name', 'age'], { language: 'en-US' });
// fields4 will be like:
// [
//   { key: 'title', dataIndex: 'title', title: 'Title' },
//   { key: 'name', dataIndex: 'name', title: 'Name' },
//   { key: 'age', dataIndex: 'age', title: 'Age' }
// ]

license

Code released under the MIT license.