メインコンテンツへスキップ
Plug-in 作成 編集

開発者向けプラグイン作成ガイド

このドキュメントは、開発者向けのプラグイン開発ガイドです。



必要な前提条件

• CLI (コマンドラインインターフェース)

• npm (node package manager)

• npx (node package execute)

• TypeScriptベースのReact

• Python (ライブラリによっては必要)



推奨IDEおよびフレームワーク

Visual Studio Code

NodeJs



ライブラリ

MIDAS ITは、プラグイン開発を簡素化するためのさまざまなライブラリを提供しています。

 

1. テンプレート - @midasit-dev/cra-template-moaui - npm

  • React、TypeScript、moaui、Pyscript*で構成されたプラグイン開発テンプレートです。

 

2. Pyscriptを除いたテンプレート: @midasit-dev/cra-template-moaui-light - npm

  • React、TypeScript、moauiで構成されたプラグイン開発テンプレートです。

 

3. コンポーネント: @midasit-dev/moaui-components-v1 - npm

  • Material UIに基づいたMIDAS ITのデザインを適用したUIコンポーネントです。

StoryBook: @midasit-dev/moaui-lab

 

*なぜPyscriptなのか?

エンジニアリングツールとして、プラグインには数学的な計算が本質的に必要です。Pythonはそのようなエンジニアリング計算を行うための最適なツールと考えられており、したがって組み込まれています。

 

プラグインのアップロード

開発したプラグインは、プログラムで登録して使用できます。手順は以下の通りです。

Step 1: ビルドして単一のZIPファイルにパッケージ化します。
Step 1: Build and package it into a single ZIP file

 

Step 2: プラグインプラットフォームの「My Work」タブに移動します。
Step 2: Go to the MyWork tab of the plug-in platform

 

Step 3: アップロードプロセス実行ます。
Step 3: Upload process

 

アップロードしたプラグインを実行すると(事前にAPI接続を確認してください)、開発したインターフェースが意図した通りに表示されます。

 

Uploaded Plug-in
アップロードしたプラグイン

FAQ

Q: アイコンを登録するにはどうすればよいですか?

A: プラグインは、ビルドフォルダの最上位レベルにある「icon.svg」ファイルをアイコンとして認識し、表示します(他の形式はサポートされていません)。したがって、SVGファイルを作成し、「icon.svg」として保存し、ビルドをZIPファイルにパッケージ化する際に含めてください。

 

Q: 説明文を編集するにはどうすればよいですか?

A: ビルドフォルダ内のreadme.mdファイルの内容が、プラグインの説明として表示されます。したがって、readme.mdファイルに説明文を記述し、ビルドを作成する際に含めてください。

 

Q: 他のユーザーとプラグインを共有するにはどうすればよいですか?

A: 現在、個別に開発されたプラグインをマーケットプレイスで共有するためのシステムを開発中です。

0
コンテンツが役に立ちましたか?