Document @NativeClass and co.

Offen

#12 erstellt am 18.11.2022 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: android, ios, typescript
Bereich: documentation, mobile-dev

Rechercherichtung

Beginnen Sie mit der Überprüfung der vorhandenen NativeScript-Dokumentationsstruktur und des Android-Beispiels in diesem Issue. Ermitteln Sie anschließend die aktuelle Anleitung für @NativeClass, @ObjCProtocols, @JavaProxy und @Interfaces. Dokumentieren Sie gängige native Zugriffsmuster für Android und iOS, einschließlich Delegaten, und stellen Sie sicher, dass die Verwendung und der Zweck jeder Annotation erklärt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache: JavaScript
Sterne: 17
Forks: 31
Ø Merge: 8 Std. 51 Min.
Gemergte PRs (30 T.): 2

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus NativeScript/docs

Document selectedTabTextColor prop in TabView Offen

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 68/100

NativeScript/docs#177 · Erstellt am 17.6.2025
403 error when proposing changes to docs via stackblitz Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 38/100

NativeScript/docs#189 · Erstellt am 25.11.2025
Label: maxLines Offen

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 48/100

NativeScript/docs#182 · Erstellt am 06.10.2025
ListView example for Solid.js does not render Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100

NativeScript/docs#178 · 1 Kommentar · Erstellt am 23.6.2025
[request] add `appwrite` to the recommended plugins Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 35/100

NativeScript/docs#159 · Erstellt am 08.1.2025

Alle Issues in NativeScript/docs