Skip to content

Commit

Permalink
Removes deprecated attribute from Screen component (#822)
Browse files Browse the repository at this point in the history 
Signed-off-by: Hector Custódio <hector.custodio@zup.com.br>
  • Loading branch information
@hectorcustodiozup
hectorcustodiozup committed Dec 16, 2021
1 parent 20c88cd commit 03bf7da
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 88 deletions.
87 changes: 1 addition & 86 deletions content/en/api/components/layout/screen/_index.md
View file
Expand Up @@ -4,89 +4,4 @@ weight: 20
description: Here you'll find all about screen's components and its attributes details.
---

---

## What is it?

Your screen has attributes and components that can be used and configured. On the table below, we listed the main characteristics from each of these attributes.

| **Attribute** | **Type** | Required | **Definition** |
| :--------------------- | :-------------------------------------------------------- | :------- | :---------------------------------------------------------------------------------------------------- |
| identifier | String | | Attribute that globally identifies a screen in your application so you can attributes actions for it. |
| safe area | [**Safe Area**]({{< ref path="/api/components/layout/screen/safe-area" lang="en" >}}) | | Specifies a screen's component position. |
| navigation bar | [**Navigation Bar**]({{< ref path="/api/components/layout/screen/navigation-bar" lang="en" >}}) | | Allows action/navigation's bar on the screen. |
| child | [**Server-Driven Component**]({{< ref path="/api/components/" lang="en" >}}) | ✓ | Define screen's elements. It can be any visual component that extends to`ServerDrivenComponent`. |
| style | [**Style**]({{< ref path="/api/components/widget#style-attributes" lang="en" >}}) | | Provide visual customization options to the `screen.` |
| screen analytics event | [**Screen Event**]({{< ref path="/api/analytics#screenview-option" lang="en" >}}) | | Configure analytics elements to your screen. |
| context | [**ContextData**]({{< ref path="/api/context/" lang="en" >}}) | | Screen's context. |

## How to use it?

{{< tabs id="T156" >}}
{{% tab name="JSON" %}}

<!-- json-playground:screen.json
{
"_beagleComponent_" : "beagle:screenComponent",
"navigationBar" : {
"title" : "Beagle Screen",
"showBackButton" : true,
"navigationBarItems" : [ {
"_beagleComponent_" : "beagle:navigationBarItem",
"text" : "",
"image" : {
"_beagleImagePath_" : "local",
"mobileId" : "informationImage"
},
"action" : {
"_beagleAction_" : "beagle:alert",
"title" : "Screen",
"message" : "Some message",
"labelOk" : "OK"
}
} ]
},
"child" : {
"_beagleComponent_" : "beagle:container",
"children" : [ {
"_beagleComponent_" : "beagle:text",
"text" : "Some text"
} ]
}
}
-->

{{% playground file="screen.json" language="en" %}}
{{% /tab %}}

{{% tab name="Kotlin DSL" %}}

```kotlin
Screen(
navigationBar = NavigationBar(
title = "Beagle Screen",
showBackButton = true,
navigationBarItems = listOf(
NavigationBarItem(
text = "",
image = Local.justMobile("informationImage"),
action = Alert(
title = "Screen",
message = "Some message",
labelOk = "OK"
)
)
)
),
child = Container(
children = listOf(
Text("Some text")
)
)
)
```

{{% /tab %}}
{{< /tabs >}}

### 👉 [Test this example in the Web Playground](https://beagle-playground.netlify.app/)
---
1 change: 0 additions & 1 deletion content/en/api/components/layout/screen/overview.md
View file
Expand Up @@ -18,7 +18,6 @@ Your screen has attributes and components that can be used and configured. On th
| navigation bar | [**Navigation Bar**]({{< ref path="/api/components/layout/screen/navigation-bar" lang="en" >}}) | | Allows action/navigation's bar on the screen. |
| child | [**Server-Driven Component**]({{< ref path="/api/components/" lang="en" >}}) | ✓ | Define screen's elements. It can be any visual component that extends to`ServerDrivenComponent`. |
| style | [**Style**]({{< ref path="/api/components/widget#style-attributes" lang="en" >}}) | | Provide visual customization options to the `screen.` |
| screen analytics event | [**Screen Event**]({{< ref path="/api/analytics#screenview-option" lang="en" >}}) | | Configure analytics elements to your screen. |
| context | [**ContextData**]({{< ref path="/api/context/" lang="en" >}}) | | Screen's context. |

## How to use it?
Expand Down
1 change: 0 additions & 1 deletion content/pt/api/components/layout/screen/overview.md
View file
Expand Up @@ -18,7 +18,6 @@ A sua tela possui atributos e componentes que podem ser usados e configurados. N
| navigation bar | [**Navigation Bar**]({{< ref path="/api/components/layout/screen/navigation-bar" lang="pt" >}}) | | Permite configurar a barra de ações/navegação na tela. |
| child | [**Server Driven Component**]({{< ref path="/api/components/" lang="pt" >}}) | ✓ | Define os elementos na tela. Pode ser qualquer componente visual que estenda de `ServerDrivenComponent`. |
| style | [**Style**]({{< ref path="/api/components/widget#atributos-do-style" lang="pt" >}}) | | Fornece opções de customização visual para a `Screen.` |
| screen analytics event | [**Screen Event**]({{< ref path="/api/analytics#opção-screenview" lang="pt" >}}) | | Configura elementos de análise\(Analytics\) na sua tela. |
| context | [**ContextData**]({{< ref path="/api/context/" lang="pt" >}}) | | Contexto da tela. |

## Como usar?
Expand Down

0 comments on commit 03bf7da

Please sign in to comment.