NativeScript / NativeScript/docs
Document @NativeClass and co.
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- JavaScript
- Estrelas
- 17
- Forks
- 31
- Merge médio
- 8h 51min
- PRs com merge (30d)
- 2
Descrição
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.
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece revisando a estrutura existente da documentação do NativeScript e o exemplo de Android nesta issue; em seguida, identifique as orientações atuais para @NativeClass, @ObjCProtocols, @JavaProxy e @Interfaces. Documente padrões comuns de acesso nativo no Android e no iOS, incluindo delegates, e certifique-se de que o uso e a finalidade de cada anotação sejam explicados.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- android, ios, typescript
- Domínio
- documentation, mobile-dev
- Tipo de issue
- Documentação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100