NativeScript / NativeScript/docs
Document @NativeClass and co.
オープン
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 17
- フォーク
- 31
- 平均マージ
- 8時間 51分
- マージ済み PR(30日)
- 2
説明
From @vallemar
...how and when to use the @NativeClass or @Interface annotations, also how to add delegates in iOS. In general, how to access native under the most common situations
Example android class
@NativeClass()
@Interfaces([android.hardware.SensorEventListener])
class SensorEventListenerAndroid
extends java.lang.Object
implements android.hardware.SensorEventListener
{
callback: (event: number[]) => void;
callbackOnAccuracyChanged: (
sensor: android.hardware.Sensor,
accuracy: number
) => void;
constructor(callback: (data) => void) {
super();
this.callback = callback;
return global.__native(this);
}
onAccuracyChanged(sensor: android.hardware.Sensor, accuracy: number): void {
if (this.callbackOnAccuracyChanged) {
this.callbackOnAccuracyChanged(sensor, accuracy);
}
}
onSensorChanged(event: android.hardware.SensorEvent): void {
if (!event || (event.values.length === 0 && event.values[0])) return;
this.callback(event.values as number[]);
}
}
export { SensorEventListenerAndroid };
Document:
@NativeClass@ObjCProtocols@JavaProxy@Interfaces- ... ?
Eventually, we'll consolidate all of these into the @NativeClass as parameters, but until then, let's document all of these.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、既存のNativeScriptドキュメントの構成と、このissueにあるAndroidの例を確認し、次に@NativeClass、@ObjCProtocols、@JavaProxy、@Interfacesに関する現在のガイダンスを特定します。デリゲートを含む、AndroidおよびiOSで一般的なネイティブアクセスパターンを文書化し、各アノテーションの使用方法と目的が説明されていることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- android, ios, typescript
- 領域
- documentation, mobile-dev
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100