T Comm

Appearance

引入 ​

ts
import {
  V_CONSOLE_STATE,
  genVConsole,
  showVConsole,
  closeVConsole,
  toggleVConsole,
  checkAndShowVConsole,
  loadVConsole
} from 't-comm';

// 不支持 tree-shaking 的项目
import {
  V_CONSOLE_STATE,
  genVConsole,
  showVConsole,
  closeVConsole,
  toggleVConsole,
  checkAndShowVConsole,
  loadVConsole
} from 't-comm/lib/v-console/index';

// 只支持 ESM 的项目
import {
  V_CONSOLE_STATE,
  genVConsole,
  showVConsole,
  closeVConsole,
  toggleVConsole,
  checkAndShowVConsole,
  loadVConsole
} from 't-comm/es/v-console/index';

V_CONSOLE_STATE ​

描述：vConsole 当前展示状态

参数：

示例

ts
import { V_CONSOLE_STATE, toggleVConsole } from 't-comm';

console.log(V_CONSOLE_STATE.show); // false
toggleVConsole();
console.log(V_CONSOLE_STATE.show); // true

genVConsole(params) ​

描述：生成 v-console 有几种情况：

    - 不显示 - 立即显示 - 异步判断后，确定是否显示

参数：

参数名描述
params参数

示例

ts
genVConsole({
  immediateShow: isShowVConsole === 'true'
    || isTestEnv()
    || noDelay === V_CONSOLE_NO_DELAY.VALUE,
  hide: isShowVConsole === 'false' || !!UserInfo.tipUid(),
  asyncConfirmFunc: checkIsDevList,
});

showVConsole() ​

描述：展示 vConsole

参数：

示例

ts
showVConsole()

closeVConsole() ​

描述：关闭 vConsole

参数：

示例

ts
closeVConsole()

toggleVConsole() ​

描述：切换展示 vConsole

参数：

返回: 是否展示

示例

ts
toggleVConsole()

checkAndShowVConsole() ​

描述：检查 localStorage 设置，并展示vConsole

参数：

示例

ts
checkAndShowVConsole()

loadVConsole([options], [plugins]) ​

描述：加载 vConsole

参数：

参数名类型默认值描述
[options]Object{}vConsole 选项
[plugins]Array<string>[]插件列表

返回: Promise.<Object>

vConsole 实例

示例

ts
loadVConsole()