Skip to content

Commit 0dd8f6a

Browse files
alexhiroshirigor789
authored andcommitted
Updated documentation (#129)
* add locale to brazilian portuguese * translate to brazilian portuguese * translate to pt-BR, initialize translation * translate to pt-BR * add note to use TabViewItem * update Vue router docs * add note to use plugin * translate titles * improve documentation and examples * improve documentation * add reference to TextBase and EditableTextBase * improve documentation * fix FormattedString link * update documentation for prompt * update documentation for login dialog * update documentation for confirm * update documentation for alert * update documentation for action
1 parent b9e8987 commit 0dd8f6a

File tree

9 files changed

+149
-89
lines changed

9 files changed

+149
-89
lines changed

content/docs/pt-BR/elements/components/switch.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ apiRef: https://docs.nativescript.org/api-reference/classes/_ui_switch_.switch
44
contributors: [alexhiroshi]
55
---
66

7-
O componente Switch permite o usuário escolher entre dois estados.
8-
O estado padrão é `false` ou "off".
7+
`<Switch>` é um componente de UI que permite o usuário escolher entre dois estados.
8+
9+
O estado padrão é `false` ou OFF.
910

1011
---
1112

1213
```html
1314
<Switch checked="true" />
1415
```
1516

16-
**Nota**: Esse componente suporta two-way data binding usando `v-model`:
17+
`<Switch>` suporta two-way data binding usando `v-model`:
1718

1819
```html
1920
<Switch v-model="itemEnabled" />
@@ -25,7 +26,7 @@ O estado padrão é `false` ou "off".
2526

2627
| nome | tipo | descrição |
2728
|------|------|-------------|
28-
| `checked` | `Boolean` | Valor boleano representando o estado do switch.
29+
| `checked` | `Boolean` | Obtém ou define o valor do estado do switch.<br/>Valor padrão: `false`.
2930

3031
## Eventos
3132

@@ -36,4 +37,4 @@ O estado padrão é `false` ou "off".
3637
## Componente Nativo
3738
| Android | iOS |
3839
|---------|-----|
39-
| android.widget.Switch | UISwitch
40+
[`android.widget.Switch`](https://developer.android.com/reference/android/widget/Switch.html) | [`UISwitch`](https://developer.apple.com/documentation/uikit/uiswitch)

content/docs/pt-BR/elements/components/text-field.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ contributors: [alexhiroshi]
77

88
`<TextField>` é um componente de campo de texto editável com uma única linha.
99

10+
`<TextField>` estende [`TextBase`](https://docs.nativescript.org/api-reference/classes/_ui_text_base_.textbase) e [`EditableTextBase`](https://docs.nativescript.org/api-reference/classes/_ui_editor_text_base_.editabletextbase) que fornece propriedades e eventos adicionais.
11+
1012
---
1113

1214
```html

content/docs/pt-BR/elements/components/time-picker.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@ contributors: [alexhiroshi]
55

66
---
77

8-
O componente TimePicker permite o usuário selecionar a hora formatada.
8+
`<TimePicker>` é um componente de UI que permite o usuário selecionar a hora.
99

10+
Veja também: [DatePicker](/pt-BR/docs/elements/components/date-picker).
1011
---
1112

1213
```html
1314
<TimePicker :hour="selectedHour" :minute="selectedMinute" />
1415
```
1516

16-
**Nota**: Esse componente suporta two-way data binding usando `v-model`:
17+
`<TimePicker>` suporta two-way data binding usando `v-model`.
1718

1819
```html
1920
<TimePicker v-model="selectedTime" />
@@ -32,7 +33,7 @@ O componente TimePicker permite o usuário selecionar a hora formatada.
3233
| `maxHour` | `Number` | A hora máxima selecionável.
3334
| `minMinute` | `Number` | O minuto mínimo selecionável.
3435
| `maxMinute` | `Number` | O minuto máximo selecionável.
35-
| `minuteInterval` | `Number` | O intervalo entre os minutos selecionáveis.
36+
| `minuteInterval` | `Number` | O intervalo entre os minutos selecionáveis. Por exemplo: 5 ou 15 minutos.<br>Valor padrão: `1`.
3637

3738
## Eventos
3839

@@ -43,4 +44,4 @@ O componente TimePicker permite o usuário selecionar a hora formatada.
4344
## Componente Nativo
4445
| Android | iOS |
4546
|---------|-----|
46-
| android.widget.TimePicker | UIDatePicker
47+
| [`android.widget.TimePicker`](https://developer.android.com/reference/android/widget/TimePicker) | [`UIDatePicker`](https://developer.apple.com/documentation/uikit/uidatepicker)

content/docs/pt-BR/elements/components/web-view.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,17 @@ apiRef: https://docs.nativescript.org/api-reference/classes/_ui_web_view_.webvie
44
contributors: [alexhiroshi]
55
---
66

7-
O componente WebView é usado para exibir conteúdo da web dentro do seu aplicativo.
8-
Você pode usar o componente adicionando um atributo `src` que aponta para uma URL ou um arquivo HTML local.
7+
`<WebView>` é um componente de UI que deixa você exibir contéudo da web no seu aplicativo. Você pode puxar e mostrar conteúdo a partir de uma Uou um arquivo HTML local, ou você pode renderRL izar contéudo estático em HTML.
98

9+
Veja também: [HtmlView](/pt-BR/docs/elements/components/html-view).
1010
---
1111

1212
```html
1313
<WebView src="http://nativescript-vue.org/" />
14+
15+
<WebView src="~/html/index.html" />
16+
17+
<WebView src="<div><h1>Some static HTML</h1></div>" />
1418
```
1519

1620
[> screenshots for=WebView <]
@@ -19,7 +23,7 @@ Você pode usar o componente adicionando um atributo `src` que aponta para uma U
1923

2024
| nome | tipo | descrição |
2125
|------|------|-------------|
22-
| `src` | `String` | A fonte da página que será exibida.
26+
| `src` | `String` | Obtém ou define o conteúdo web.<br/>Valores válidos: uma URL absoluta, o caminho do arquivo HTML local, ou HTML estático.
2327

2428
## Eventos
2529

@@ -31,4 +35,4 @@ Você pode usar o componente adicionando um atributo `src` que aponta para uma U
3135
## Componente Nativo
3236
| Android | iOS |
3337
|---------|-----|
34-
| android.webkit.WebView | WKWebView
38+
| [`android.webkit.WebView`](https://developer.android.com/reference/android/webkit/WebView) | [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview)

content/docs/pt-BR/elements/dialogs/action.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ apiRef: https://docs.nativescript.org/api-reference/modules/_ui_dialogs_#action
44
contributors: [alexhiroshi]
55
---
66

7-
O ActionDialog permite você criar um diálogo com uma lista de opções selecionáveis.
7+
O método `action()` exibe uma lista de opções selecionáveis e um botão para cancelar. Use-o para que o usuário escolha entre opções ou descarte a seleção.
8+
9+
O método faz parte do [módulo `dialogs`](https://docs.nativescript.org/api-reference/modules/_ui_dialogs_).
810

911
---
1012

11-
```javascript
12-
const dialogs = require('tns-core-modules/ui/dialogs')
13+
## Uso básico
14+
15+
O método `action()` está disponível globalmente. Você pode chamar de qualquer lugar do seu aplicativo.
1316

14-
module.exports = {
15-
mounted() {
16-
dialogs.action('Choose one!', 'Or cancel...', ['cheese', 'wine'])
17-
.then(result => {
18-
console.log(result);
19-
})
20-
}
21-
}
17+
```JavaScript
18+
action("Your message", "Cancel button text", ["Option1", "Option2"])
19+
.then(result => {
20+
console.log(result);
21+
});
2222
```
2323

2424
[> screenshots for=ActionDialog <]

content/docs/pt-BR/elements/dialogs/alert.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,33 @@ apiRef: https://docs.nativescript.org/api-reference/modules/_ui_dialogs_#alert
44
contributors: [alexhiroshi]
55
---
66

7-
O AlertDialog irá funcionar como um simples modal de notificação que requer confirmação.
7+
O método `alert()` exibe uma mensagem e um botão de OK. Use-o para mostrar informações e notificações que não precisam de uma ação do usuário.
8+
9+
O método faz parte do [módulo `dialogs`](https://docs.nativescript.org/api-reference/modules/_ui_dialogs_).
810

911
---
1012

11-
```javascript
12-
const dialogs = require('tns-core-modules/ui/dialogs')
13-
14-
module.exports = {
15-
mounted() {
16-
dialogs.alert('Hello!')
17-
.then(() => {
18-
console.log("Dialog closed")
19-
})
20-
}
21-
}
22-
```
13+
## Uso básico
2314

24-
O AlertDialog está disponível globalmente, ao invés de importa do módulo de dialogs, você pode simplesmente chamar
15+
O método `alert()` está disponível globalmente. Você pode chamar de qualquer lugar do seu aplicativo.
2516

2617
```javascript
27-
alert('Hello!')
28-
.then(() => {
29-
console.log("Dialog closed")
30-
})
18+
alert('Your message')
19+
.then(() => {
20+
console.log("Alert dialog closed.");
21+
});
3122
```
3223

33-
em qualquer lugar do seu código.
24+
## Configurar opções
3425

26+
```JavaScript
27+
alert({
28+
title: "Your title",
29+
message: "Your message",
30+
okButtonText: "Your OK button text"
31+
}).then(() => {
32+
console.log("Alert dialog closed");
33+
});
34+
```
3535

3636
[> screenshots for=AlertDialog <]

content/docs/pt-BR/elements/dialogs/confirm.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,34 @@ apiRef: https://docs.nativescript.org/api-reference/modules/_ui_dialogs_#confirm
44
contributors: [alexhiroshi]
55
---
66

7-
O ConfirmDialog funciona como um diálogo boleano (Sim/Não).
7+
O método `confirm()` exibe uma mensagem de confirmação com botões de Cancel e OK.
8+
9+
O método faz parte do [módulo `dialogs`](https://docs.nativescript.org/api-reference/modules/_ui_dialogs_).
810

911
---
1012

13+
## Uso básico
14+
15+
O método `confirm()` está disponível globalmente. Você pode chamar de qualquer lugar do seu aplicativo.
16+
1117
```javascript
12-
const dialogs = require('tns-core-modules/ui/dialogs')
13-
14-
module.exports = {
15-
mounted() {
16-
dialogs.confirm('Are you ready?')
17-
.then(result => {
18-
console.log(result)
19-
})
20-
}
21-
}
18+
confirm('Your message')
19+
.then(result => {
20+
console.log(result);
21+
});
2222
```
2323

24-
O ConfirmDialog está disponível globalmente, ao invés de importa do módulo de dialogs, você pode simplesmente chamar
24+
## Configurar opções
2525

2626
```javascript
27-
confirm('Are you ready?')
28-
.then(result => {
29-
console.log(result)
30-
})
27+
confirm({
28+
title: "Your title",
29+
message: "Your message",
30+
okButtonText: "Your OK button text",
31+
cancelButtonText: "Your Cancel text"
32+
}).then(result => {
33+
console.log(result);
34+
});
3135
```
3236

33-
em qualquer lugar do seu código.
34-
3537
[> screenshots for=ConfirmDialog <]

content/docs/pt-BR/elements/dialogs/login.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,35 @@ apiRef: https://docs.nativescript.org/api-reference/modules/_ui_dialogs_#login
44
contributors: [alexhiroshi]
55
---
66

7-
O LoginDialog tem dois campos que são usados para pedir as credenciais para o usuário.
7+
O método `login()` exibe um diálogo onde o usuário pode fornecer credenciais de login.
8+
9+
O método faz parte do [módulo `dialogs`](https://docs.nativescript.org/api-reference/modules/_ui_dialogs_).
810

911
---
1012

13+
## Uso básico
14+
15+
O método `login()` está disponível globalmente. Você pode chamar de qualquer lugar do seu aplicativo.
16+
1117
```javascript
12-
const dialogs = require('tns-core-modules/ui/dialogs')
13-
14-
module.exports = {
15-
mounted() {
16-
dialogs.login('Please log in', 'Username', 'Password')
17-
.then(result => {
18-
console.log(result)
19-
})
20-
}
21-
}
18+
login("Your message", "Username field value", "Password field value").then(result => {
19+
console.log(`Dialog result: ${result.result}, user: ${result.userName}, pwd: ${result.password}`);
20+
});
21+
```
22+
23+
## Configurar opções
24+
25+
```JavaScript
26+
login({
27+
title: "Your login title",
28+
message: "Your login message",
29+
okButtonText: "Your OK button text",
30+
cancelButtonText: "Your Cancel button text",
31+
userName: "Username field value",
32+
password: "Password field value"
33+
}).then(result => {
34+
console.log(`Dialog result: ${result.result}, user: ${result.userName}, pwd: ${result.password}`);
35+
});
2236
```
2337

2438
[> screenshots for=LoginDialog <]

content/docs/pt-BR/elements/dialogs/prompt.md

Lines changed: 53 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,68 @@ apiRef: https://docs.nativescript.org/api-reference/modules/_ui_dialogs_#prompt
44
contributors: [alexhiroshi]
55
---
66

7-
O PromptDialog permite que você solicite entrada de dados do usuário.
7+
O método `prompt()` exibe um diálogo com um campo de uma linha para o usuário digitar.
88

9-
---
9+
O método faz parte do [módulo `dialogs`](https://docs.nativescript.org/api-reference/modules/_ui_dialogs_).
1010

11-
```javascript
12-
const dialogs = require('tns-core-modules/ui/dialogs')
11+
---
1312

14-
module.exports = {
15-
mounted() {
16-
dialogs.prompt('How are you?', 'Amazing!')
17-
.then(result => {
18-
console.log(`Dialog result: ${result.result}, text: ${result.text}`)
19-
})
20-
}
21-
}
22-
```
13+
## Uso básico
2314

24-
O PromptDialog está disponível globalmente, ao invés de importa do módulo de dialogs, você pode simplesmente chamar
15+
O método `prompt()` está disponível globalmente. Você pode chamar de qualquer lugar do seu aplicativo.
2516

26-
```javascript
27-
prompt('How are you?', 'Amazing!')
17+
```JavaScript
18+
prompt('Your message to the user', 'Suggested user input')
2819
.then(result => {
2920
console.log(`Dialog result: ${result.result}, text: ${result.text}`)
3021
})
3122
```
3223

33-
em qualquer lugar do seu código.
24+
## Configurar opções
25+
26+
```JavaScript
27+
prompt({
28+
title: "Your dialog title",
29+
message: "Your message",
30+
okButtonText: "Your OK button text",
31+
cancelButtonText: "Your Cancel button text",
32+
defaultText: "Suggested user input",
33+
}).then(result => {
34+
console.log(`Dialog result: ${result.result}, text: ${result.text}`)
35+
});
36+
```
37+
38+
## Configurar tipo do campo
39+
40+
Você também pode configurar o tipo do input usando `inputType`. É possível escolher entre texto simples (`text`), campo de e-mail (`email`), e campo de senha (`password`).
41+
42+
```JavaScript
43+
inputType: dialogs.inputType.text
44+
inputType: dialogs.inputType.email
45+
inputType: dialogs.inputType.password
46+
```
47+
48+
**NOTA:** Essa opção não está disponível globalmente e você precisa adicionar o módulo `dialogs`, com require, em seu aplicativo antes de usar `inputType`.
49+
50+
```JavaScript
51+
const dialogs = require('tns-core-modules/ui/dialogs')
52+
```
53+
54+
### Exemplo
55+
56+
```JavaScript
57+
const dialogs = require('tns-core-modules/ui/dialogs')
58+
59+
prompt({
60+
title: "Email Prompt",
61+
message: "Provide your email address:",
62+
okButtonText: "OK",
63+
cancelButtonText: "Cancel",
64+
defaultText: "[email protected]",
65+
inputType: dialogs.inputType.email
66+
}).then(result => {
67+
console.log(`Dialog result: ${result.result}, text: ${result.text}`)
68+
});
69+
```
3470

3571
[> screenshots for=PromptDialog <]

0 commit comments

Comments
 (0)