@mx-admin/core v0.0.1-rc.4

@mx-admin/core

mx-admin 相關項目的通用內容，包含

• config 功能：用於同步後台環境以及依照使用情境修改部分功能
• mx-admin 通用 utility types
• 通用樣式與變數

Configuration

我們使用 AdminCore 這個實例作為後台與 mx-admin modules 的溝通介面，包含的功能有：

1. 同步環境變數
2. 同步 i18n 實例
3. 修改 api 請求路徑

同步環境變數

部分邏輯實作需要用到後台的環境變數，可以透過 AdminCore.config 來配置 env

同步 i18n 實例

部分功能會涉及 i18n 實作，AdminCore 會生成內部的 i18n 實例，但如果期望能夠與後台共用同一個 i18n 的實例，可以透過 AdminCore.config 來配置 i18n。傳參 i18n 後則會使用該 i18n 實例。

修改 api 請求路徑

部分 api 實作時，可能會在各後台有路徑上的差異，透過 AdminCore.config 來配置 rewriteApiPath，將指定路徑取代為配置路徑。

config options

options.env

必填，同步環境變數

options.serviceHost

必填，api 根路徑

options.i18n

選填，同步 i18n 實例

options.rewriteApiPath

選填，因應各後台 api 實作路徑可能有不同，因此開放配置改寫 api 路徑。

example

// src/layouts/index.js

import { AdminCore } from '@mx-admin/core';
import { getEnv } from '@/utils/getEnv';
import i18n from '@/constants/i18n';

AdminCore.config({
  env: {
    DEPLOY_ENV: getEnv('DEPLOY_ENV'),
    OSS_PORTAL_DOMAIN: getEnv('OSS_PORTAL_DOMAIN'),
  },
  i18n,
  serviceHost: '/operation-service',
  rewriteApiPath: {
    commonLang: '/common/langs',
  },
});