virtual-keyboard

Introduction:

Virtual Keyboard Plugin

• Reference
  • Method
    • Parameter
• Usage Plugins
• Usage WebComponent

Reference

Method

• setState

  Set State

import { virtualKeyboardPlugin } from "@plaoc/plugins";
virtualKeyboardPlugin.setState({ overlay: false });

• getState

  Get Current State

import { virtualKeyboardPlugin } from "@plaoc/plugins";
virtualKeyboardPlugin.getState();

• setOverlay

  Set Overlay

import { virtualKeyboardPlugin } from "@plaoc/plugins";
virtualKeyboardPlugin.setOverlay(true);

• getOverlay

  Get Overlay State

import { virtualKeyboardPlugin } from "@plaoc/plugins";
virtualKeyboardPlugin.getOverlay();

Parameter

• $VirtualKeyboardWritableState

  Virtual Keyboard State Value

import type { $VirtualKeyboardWritableState } from "@plaoc/plugins";
const state: Partial<$VirtualKeyboardWritableState> = {
  overlay: true,
};

Usage Plugins

<script setup lang="ts">
import { ref } from "vue";
import { virtualKeyboardPlugin } from "@plaoc/plugins";

async function getState() {
  const state = virtualKeyboardPlugin.getState();
}
</script>

Usage WebComponent

<script setup lang="ts">
import { ref } from "vue";
import { HTMLDwebVirtualKeyboardElement } from "@plaoc/plugins";

const $virtualKeyboardPlugin = ref<HTMLDwebVirtualKeyboardElement>();

async function getState() {
  const virtualKeyboard = $virtualKeyboardPlugin.value!;
  const state = virtualKeyboard.getState();
}

</script>
<template>
  <dweb-virtual-keyboard ref="$virtualKeyboardPlugin"></dweb-virtual-keyboard>
</template>