角度开关组件 - TypeScript

介绍

角度开关组件是一个使用 TypeScript 编写的可复用组件，可以用来展示和控制某种状态，通常表现为开/关、打开/关闭等状态。它提供了可定制的选项，例如大小、颜色、文字等，可以根据不同的应用场景进行配置和使用。

使用方式

安装角度开关组件：

npm install @myorg/angleswitch

在 TypeScript 中引入角度开关组件：

import { AngleSwitch } from '@myorg/angleswitch';

创建一个角度开关组件：

const angleSwitch = new AngleSwitch({
  size: 'medium',
  onColor: 'green',
  offColor: 'red',
  text: {
    on: '开',
    off: '关'
  },
  defaultPosition: 'off'
});

angleSwitch.appendTo(document.body);

配置选项

可配置选项如下：

size

选项大小，支持 small、medium 和 large 三种大小，默认为 medium。

const angleSwitch = new AngleSwitch({
  size: 'small'
});

onColor 和 offColor

选项开启和关闭时的颜色。可以使用任何 CSS 颜色值，例如 green、#66ccff、rgba(255, 0, 0, 0.5) 等，默认为 green 和 gray。

const angleSwitch = new AngleSwitch({
  onColor: '#66ccff',
  offColor: '#f0f0f0'
});

text

选项状态文本。可以设置开启和关闭状态的文本，默认为 { on: '开', off: '关' }。

const angleSwitch = new AngleSwitch({
  text: {
    on: 'Yes',
    off: 'No'
  }
});

defaultPosition

选项默认状态。可以设置为 on 或 off，默认为 off。

const angleSwitch = new AngleSwitch({
  defaultPosition: 'on'
});

API

角度开关组件提供了以下 API：

isOn()

获取当前组件状态是否为开启状态。

const isOn = angleSwitch.isOn(); // true or false

turnOn()

将组件状态设置为开启状态。

angleSwitch.turnOn();

turnOff()

将组件状态设置为关闭状态。

angleSwitch.turnOff();

toggle()

切换组件当前状态。如果当前状态为开启，则切换为关闭；如果当前状态为关闭，则切换为开启。

angleSwitch.toggle();

结束语

角度开关组件是一个非常实用的可复用组件，在开发实际项目中可以大大降低开发成本和提升用户体验。本文介绍了组件的基本使用方式和配置选项，希望能对大家有所帮助。