virtual-keyboard-input

YVKeyboard

YVKeyboard is a code repository for a virtual keyboard designed to run on Yocto Linux. It serves as a reusable Vue component for all UVN products in the MOL team.

Table of Contents

• YVKeyboard
  • Table of Contents
  • Installation
  • Usage
  • Contributing
  • License

Installation

To install YVKeyboard, follow these steps:

1. Clone the repository:

git clone https://github.com/your-username/YVKeyboard.git

2. Install the necessary dependencies:

npm install

3. Build the project:

npm run build

Usage

To use virtual-keyboard-input in your UVN products, follow these steps:

1. Import the virtual-keyboard-input component into your Vue project:

import keyboard from 'virtual-keyboard-input';

2. Add the keyboard component to your template:

<template>
  <div>
    <!-- Your UVN product content here -->
    <keyboard type="text" v-model:value="value"></keyboard>
  </div>
</template>

3. The keyboard component accepts the following props:

   • v-model:value (required)
   • type (required): text or number
   • width: number
   • height: number
   • disabled: boolean
   • placeholder: string
   • isInteger: boolean (Whether the decimal point is disabled)
   • isTextCenter: boolean
   • maxLength: number (Limit the maximum input character)
   • isPassword: boolean (Whether to turn on the password keyboard)
   • openAudio: boolean (Whether to turn on keyboard sound)
   • useKeyboard: boolean (Whether to turn on the soft keyboard)
   • validateFiled: Function (Custom Inspection input)

   <template>
     <div>
       <keyboard
         v-model:value="e1000"
         width="500"
         type="number"
         placeholder="123123asdasd"
         :validateFiled="(value, callback) => {
           if (value.length > 5) {
             callback("max five");
           } else {
             callback();
           }
         }"
     ></keyboard>
     </div>
   </template>

   Default values:

   • v-model:value: ''
   • type: 'text'
   • width: 104
   • height: 60
   • disabled: false
   • placeholder: ''
   • isInteger: false
   • isTextCenter: false
   • maxLength: ''
   • isPassword: false
   • openAudio: true
   • useKeyboard: true
   • validateFiled: ''

4. The keyboard component accepts the following Events:

   • input: Function (Triggered when the input value changes. The updated value is passed as the event payload.)
   • blur: Function (blur when the input value changes. The updated value is passed as the event payload.)
   • change: Function (change when the input value changes. The updated value is passed as the event payload.)

Contributing

We welcome contributions to YVKeyboard! To contribute, please follow these guidelines:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive commit messages.
4. Push your changes to your forked repository.
5. Submit a pull request to the main repository.

License

YVKeyboard is licensed under the MIT License.

Please note that this is just an example template for your Readme.md file. Feel free to modify it to fit the specific requirements of your project.