{"id":15138378,"url":"https://github.com/myscript/myscript-common-element","last_synced_at":"2025-09-29T06:31:38.426Z","repository":{"id":57306755,"uuid":"45406688","full_name":"MyScript/myscript-common-element","owner":"MyScript","description":":pencil2: :cloud: myscript-common-element is the common layer of myscript-math-web and myscript-text-web","archived":true,"fork":false,"pushed_at":"2021-01-04T15:31:32.000Z","size":21591,"stargazers_count":5,"open_issues_count":0,"forks_count":4,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-09-27T07:22:37.475Z","etag":null,"topics":["cloud","handwriting-recognition","math","polymer","webcomponents"],"latest_commit_sha":null,"homepage":"https://developer.myscript.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MyScript.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-02T16:27:59.000Z","updated_at":"2023-01-28T11:15:12.000Z","dependencies_parsed_at":"2022-08-29T07:30:38.415Z","dependency_job_id":null,"html_url":"https://github.com/MyScript/myscript-common-element","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MyScript%2Fmyscript-common-element","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MyScript%2Fmyscript-common-element/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MyScript%2Fmyscript-common-element/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MyScript%2Fmyscript-common-element/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MyScript","download_url":"https://codeload.github.com/MyScript/myscript-common-element/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234597574,"owners_count":18857980,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud","handwriting-recognition","math","polymer","webcomponents"],"created_at":"2024-09-26T07:22:49.392Z","updated_at":"2025-09-29T06:31:37.376Z","avatar_url":"https://github.com/MyScript.png","language":"JavaScript","readme":"# MyScript Common Element\n\n[![npm version](https://badge.fury.io/js/myscript-common-element.svg)](https://badge.fury.io/js/myscript-common-element)\n[![Examples](https://img.shields.io/badge/Link%20to-examples-blue.svg)](https://myscript.github.io/myscript-common-element/#/elements/myscript-common-element/demos/other-demonstrations)\n[![Documentation](https://img.shields.io/badge/Link%20to-documentation-green.svg)](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/)\n\n## :warning: This repository is archived :warning:\niinkJS 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.\n\nFor more information, please see [documentation](https://developer.myscript.com/).\n\nWe also provide an example to integrate [iinkJS](https://github.com/MyScript/iinkJS) as webcomponent: [link](https://github.com/MyScript/web-integration-samples).\n\n\u003cdiv align=\"center\"\u003e\n\n:construction:\n\n\u003c/div\u003e\n\n\u003e The common layer of [myscript-math-web](https://github.com/MyScript/myscript-math-web) and [myscript-text-web](https://github.com/MyScript/myscript-text-web). \n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"preview.gif\"\u003e\n\u003c/div\u003e\n\n`myscript-common-element` is a Web component that can be used in every web application to bring handwriting recognition and conversion. \n\nIt integrates all you need:\n* Signal capture for all devices,\n* Digital ink rendering,\n* Link to MyScript Cloud to bring handwriting recognition.\n\nIf you are not familiar with [Web components](https://www.webcomponents.org/) and [Polymer](https://www.polymer-project.org/), please consider using [MyScriptJS](https://github.com/MyScript/MyScriptJS) or our out-of-the-box components [myscript-math-web](https://github.com/MyScript/myscript-math-web) and [myscript-text-web](https://github.com/MyScript/myscript-text-web).  \n\n## Table of contents\n\n* [Examples](https://github.com/MyScript/myscript-common-element#examples)\n* [Features](https://github.com/MyScript/myscript-common-element#features)\n* [Requirements](https://github.com/MyScript/myscript-common-element#requirements)\n* [Installation](https://github.com/MyScript/myscript-common-element#installation)\n* [Usage](https://github.com/MyScript/myscript-common-element#usage)\n* [Documentation](https://github.com/MyScript/myscript-common-element#documentation)\n* [Support](https://github.com/MyScript/myscript-common-element#support)\n* [Feedback](https://github.com/MyScript/myscript-common-element#sharing-your-feedback)\n* [Contributing](https://github.com/MyScript/myscript-common-element#contributing)\n\n## Examples\n\nIf you're not familiar with MyScript and Interactive Ink, consider discovering its major features with our [text demo and tutorial](http://webdemo.myscript.com/views/text.html).\n\n[Simple text example](https://myscript.github.io/myscript-common-element/#/elements/myscript-common-element/demos/get-started-[v4]) of `myscript-common-element`. \n\n[All our examples](https://myscript.github.io/myscript-common-element/#/elements/myscript-common-element/demos/other-demonstrations) with the [source codes](https://github.com/MyScript/myscript-common-element/tree/master/src/demo-app/examples).\n\n## Features\n\n* Easy to integrate,\n* Digital ink capture and rendering,\n* Rich editing gestures,\n* Import and export content,\n* Styling,\n* Typeset support,\n* More than 200 mathematical symbols supported,\n* 65 supported languages.\n\nYou can discover all the features on our Developer website for [Text](https://developer.myscript.com/text) and [Math](https://developer.myscript.com/math).\n\n## Requirements\n\n1. Have [npm](https://www.npmjs.com/get-npm) or [yarn](https://yarnpkg.com/en/docs/install) installed.\n2. Have a MyScript developer account. You can create one [here](https://dev.myscript.com/).\n3. Get your keys and the free monthly quota to access MyScript Cloud at [developer.myscript.com](https://developer.myscript.com/getting-started/web)\n \n## Installation\n  \nUse an existing project or start a fresh one.\n\n```shell\nnpm init\n```\n\nInstall `myscript-common-element` and use it as showed in the [Usage]() section.\n\n```shell\nnpm install myscript-common-element\n```\n\n## Usage\n\n1. Create an `index.html` file in the same directory. \n\n2. Add the following lines in the `head` section to import the library and the webcomponents polyfill.\n```html\n\u003cscript type=\"module\" src=\"node_modules/myscript-common-element/myscript-common-element.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js\"\u003e\u003c/script\u003e\n```  \n\n3. Still in the `head` section, add the following style:\n```html\n\u003cstyle\u003e\n    myscript-common-element {\n        height: 100vh;\n    }\n\u003c/style\u003e\n```\n\n4. Use the component in the `body` section with the keys you received by mail.\n```html\n  \u003cmyscript-common-element\n        applicationkey=\"YOUR MYSCRIPT DEVELOPER APPLICATION KEY\"\n        hmackey=\"YOUR MYSCRIPT DEVELOPER HMAC KEY\"\u003e\n  \u003c/myscript-common-element\u003e\n```\n\n5. Your `index.html` file should look like this:\n```html\n\u003chtml\u003e\n    \u003chead\u003e\n        \u003cscript type=\"module\" src=\"node_modules/myscript-common-element/myscript-common-element.js\"\u003e\u003c/script\u003e\n        \u003cscript src=\"node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js\"\u003e\u003c/script\u003e\n        \u003cstyle\u003e\n            myscript-common-element {\n                height: 100vh;\n            }\n        \u003c/style\u003e\n    \u003c/head\u003e\n    \u003cbody\u003e\n      \u003cmyscript-common-element\n        applicationkey=\"YOUR MYSCRIPT DEVELOPER APPLICATION KEY\"\n        hmackey=\"YOUR MYSCRIPT DEVELOPER HMAC KEY\"\u003e\n      \u003c/myscript-common-element\u003e\n    \u003c/body\u003e\n\u003c/html\u003e\n```\n\n6. 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](https://www.polymer-project.org/3.0/start/install-3-0).\n```\npolymer serve\n```\n\nYou can find this guide and a more complete example on the [MyScript Developer website](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/).\n\n## Documentation\n\nYou can find a complete documentation with the following sections on our Developer website:\n\n* **Get Started**: [how to use myscript-common-element with a full example](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/get-started/),\n* **Editing**: [how to interact with content](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/editing/),\n* **Conversion**: [how to convert your handwritten content](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/conversion/),\n* **Import and Export**: [how to import and export your content](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/import-and-export/),\n* **Styling**: [how to style content](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/styling/).\n\nWe also provide a complete [API Reference](https://myscript.github.io/myscript-common-element/).\n\n## Getting support\n\nYou can get support and ask your questions on the [dedicated section](https://developer-support.myscript.com/support/discussions/forums/16000096021) of MyScript Developer website.\n\n## Sharing your feedback\n\nMade a cool app with `myscript-common-element`? We would love to hear about you!\nWe’re planning to showcase apps using it so let us know by sending a quick mail to [myapp@myscript.com](mailto://myapp@myscript.com)\n\n## Contributing\n\nWe welcome your contributions: if you would like to extend `myscript-common-element` for your needs, feel free to fork it!\n\nPlease take a look at our [contributing](CONTRIBUTING.md) guidelines before submitting your pull request.\n\n## License\nThis library is licensed under the [Apache 2.0](http://opensource.org/licenses/Apache-2.0).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmyscript%2Fmyscript-common-element","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmyscript%2Fmyscript-common-element","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmyscript%2Fmyscript-common-element/lists"}