hyaminh2303 / kintone-ui-component Goto Github PK

kintone UI Component is UI Component for kintone customization.
It supports you to develop kintone customization and kintone plugin.
The document page is here.

English | 日本語

• Table of contents
• Installation
  • UMD
  • CDN
  • npm
• Usage
• Browser Support
• v0 Usage
• Migration Guide
• Contributing
• License

kintone UI Component is available as UMD, CDN and npm package.

Please use kuc.min.js downloaded from releases page.

./umd/kuc.min.js

Please use these CDN link.

• If you want to load the latest version of kintone UI Component:

  https://unpkg.com/kintone-ui-component/umd/kuc.min.js
  

• If you want to specify the version and load it (specify the version number after the project name):

  https://unpkg.com/[email protected]/umd/kuc.min.js
  

unpkg is not supported by Cybozu. We recommend you to use it for verification.
In a production environment, please use UMD to avoid the possible effects of unpkg technical obstacle and glitches.

Please install and use kintone-ui-component with npm.

npm install kintone-ui-component

// UMD
const text = new Kuc.Text({
  value: "this is text!"
});

// ES modules
import { Text } from "kintone-ui-component/lib/text";

const text = new Text({
  value: "this is text!"
});
text.addEventListener("change", event => {
  console.log(`text value is changed to ${event.detail.value}`);
});

We confirmed the operation with the latest version of each compatible browser.

If you want to use kintone UI Component v0.x.x, please refer to these pages.

• GitHub repository
• Document page

With the release of kintone UI Component v1, we will continue to mainly fix bugs and update libraries for v0.
We don't plan to develop new functions for now.

There are differences in specifications and interfaces between v0 and v1.
Please be sure to verify enough when you updating.
For more details, please refer to the articles below.

• The difference of the way to code between v0 and v1
• v1.0.0 Release Notes

About the React version provided in v0, we haven't supported it in v1 now.

We welcome contributions to kintone UI Component.
If you have a question, feature request, please register GitHub issue.

MIT LICENSE