MyScript Text Web

⚠️ This repository is archived ⚠️

iinkJS grants you high integration flexibility by letting you choose your favorite framework or components. For this reason, we have decided to focus on iinkJS and to discontinue our ready-to-use Web components.

For more information, please see documentation.

We also provide an example to integrate iinkJS as webcomponent: link.

🚧

The easy way to integrate text handwriting recognition in your web app.

myscript-text-web is a Web component that can be used in every web application to bring text handwriting recognition and conversion.

It integrates all you need:

Signal capture for all devices,
Digital ink rendering,
Link to MyScript Cloud to bring handwriting recognition.

Examples

If you're not familiar with MyScript and Interactive Ink, consider discovering its major features with our text demo and tutorial.

Simple example of myscript-text-web.

All our examples with the source codes.

Features

Easy to integrate,
Digital ink capture and rendering,
Rich editing gestures,
Import and export content,
Styling,
Typeset support,
65 supported languages.

You can discover all the text features on our Developer website.

Requirements

Have npm or yarn installed.
Have a MyScript developer account. You can create one here.
Get your keys and the free monthly quota to access MyScript Cloud at developer.myscript.com

Installation

Use an existing project or start a fresh one.

npm init

Install myscript-text-web and use it as showed in the Usage section.

npm install myscript-text-web

Usage

Create an index.html file in the same directory.
Add the following lines in the head section to import the library and the webcomponents polyfill.

<script type="module" src="node_modules/myscript-text-web/myscript-text-web.js"></script>
<script src="node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js"></script>

Still in the head section, add the following style:

<style>
    myscript-text-web {
        height: 100vh;
    }
</style>

Use the component in the body section with the keys you received by mail.

<myscript-text-web
  applicationkey="YOUR MYSCRIPT DEVELOPER APPLICATION KEY"
  hmackey="YOUR MYSCRIPT DEVELOPER HMAC KEY">
</myscript-text-web>

Your index.html file should look like this:

<html>
    <head>
        <script type="module" src="node_modules/myscript-text-web/myscript-text-web.js"></script>
        <script src="node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js"></script>
        <style>
            myscript-text-web {
                height: 100vh;
            }
        </style>
    </head>
    <body>
      <myscript-text-web
        applicationkey="YOUR MYSCRIPT DEVELOPER APPLICATION KEY"
        hmackey="YOUR MYSCRIPT DEVELOPER HMAC KEY">
      </myscript-text-web>
    </body>
</html>

Launch a local Web server to start using it! We recommend to use the polymer one, you can find more information on the Polymer website.

polymer serve

You can find this guide and a more complete example on the MyScript Developer website.

Documentation

You can find a complete documentation with the following sections on our Developer website:

Get Started: how to use myscript-text-web with a full example,
Editing: how to interact with content,
Conversion: how to convert your handwritten content,
Import and Export: how to import and export your content,
Styling: how to style content.

We also provide a complete API Reference.

Getting support

You can get support and ask your questions on the dedicated section of MyScript Developer website.

Sharing your feedback

Made a cool app with myscript-text-web? We would love to hear about you! We’re planning to showcase apps using it so let us know by sending a quick mail to [email protected]

Contributing

We welcome your contributions: if you wish to contribute to myscript-text-web, feel free to fork it!

Please take a look at our contributing guidelines before submitting your pull request.

License

This library is licensed under the Apache 2.0.

MyScript/myscript-text-web

MyScript

Reviews

Repository Details