auto-actions

补充信息

用于自动生成 action。

提示

• @modern-js-reduck/plugin-auto-action 内置于 Modern.js，默认开启。
• 可通过 modern.config.js 关闭插件。

@modern-js-reduck/plugin-auto-action 是 Modern.js 的状态管理插件，它可以根据 state 的类型，自动生成相应的 actions，为修改 state 提供便利。

示例

基础数据类型

state 类型为 string、number、boolean、undefined、null 时，生成 setState action。

示例

import { model, useModel } from '@modern-js/runtime/model';

const fooModel = model('foo').define({
  state: 1
});

function App() {
  const [state, actions] = useModel(fooModel);

  return <div>
    <div>State: {state}</div>
    <button type="button" onClick={() => {
      actions.setState(state + 1);
    }}>add</button>
  </div>
}

数组 Array

state 类型为 Array 时，生成下列 actions：

• push：将一个或多个元素添加到数组的末尾。
• pop：从数组中删除最后一个元素。
• shift：从数组中删除第一个元素。
• unshift：将一个或多个元素添加到数组的开头。
  • 语法：arr.unshift(element1, ..., elementN)
  • elementN：要添加到数组开头的元素或多个元素。
• filter：过滤元素。
• concat：拼接数组。
• splice：通过删除或替换现有元素或者原地添加新的元素来修改数组,并以数组形式返回被修改的内容。此方法会改变原数组。
  • 语法：splice(start[, deleteCount[, item1[, item2[, ...]]]])
  • start：指定修改的开始位置（从0计数）。
  • deleteCount：可选，整数，表示要移除的数组元素的个数。
  • item, item2, ...：可选，要添加进数组的元素,从start 位置开始。如果不指定，则 splice() 将只删除数组元素。

示例

import { model, useModel } from '@modern-js/runtime/model';

const fooModel = model('foo').define({
  state: [1, 2, 3]
});

function App() {
  const [state, actions] = useModel(fooModel);

  useEffect(() => {
    actions.push(4);
    actions.pop();
    actions.shift(0);
    actions.unshift();
    actions.filter(val => val <= 2);
    actions.splice(0, 1, 1, 2);
  }, []);

  return <div>
    <div>State: {state}</div>
  </div>
}

对象 Record<string, any>

state 类型为 Record<string, any> 时，生成 set${key}（小驼峰命名）。

示例

import { model, useModel } from '@modern-js/runtime/model';

const fooModel = model('foo').define({
  state: {
    a: 1,
    b: { value: 1 },
    c: 'c'
  }
});

function App() {
  const [state, actions] = useModel(fooModel);

  useEffect(() => {
    actions.setA(2);
    actions.setB({ value: 2 });
    actions.setC('d');
  }, []);

  return <div>
    <div>State: {state}</div>
  </div>
}