Added code examples for the dialog element (#1905)

* Added code examples for the dialog block
* Code examples renamed to use _ instead of -

doc/gui/examples/binding_lov_is_enum/__init__.py

@@ -0,0 +1 @@
+# This file makes this directory a module on its own, mandatory for mypy.

doc/gui/examples/binding_lov_is_enum/builder.py

@@ -0,0 +1,46 @@
+# Copyright 2021-2024 Avaiga Private Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+# -----------------------------------------------------------------------------------------
+# To execute this script, make sure that the taipy-gui package is installed in your
+# Python environment and run:
+#     python <script>
+# -----------------------------------------------------------------------------------------
+from enum import Enum
+
+import taipy.gui.builder as tgb
+from taipy.gui import Gui
+
+
+# Color values are enumerated
+class Color(Enum):
+    RED = 0
+    GREEN = 1
+    BLUE = 2
+
+
+# Initial selected color
+# Note that [color] is an enumeration member and [color_value] in a member value
+color = Color.RED
+color_value = color.value
+
+
+with tgb.Page() as page:
+    tgb.html("h2", "Using enumeration member:")
+    tgb.toggle("{color}", lov="{Color}")
+    tgb.text("{str(color)}")
+
+    tgb.html("h2", "Using enumeration value:")
+    tgb.toggle("{color_value}", lov=Color)
+    tgb.text("{color_value}")
+
+
+if __name__ == "__main__":
+    Gui(page).run(title="Binding - LoV as Enum")

doc/gui/examples/binding_lov_is_enum/markdown.py

@@ -0,0 +1,41 @@
+# Copyright 2021-2024 Avaiga Private Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+# -----------------------------------------------------------------------------------------
+# To execute this script, make sure that the taipy-gui package is installed in your
+# Python environment and run:
+#     python <script>
+# -----------------------------------------------------------------------------------------
+from enum import Enum
+
+from taipy.gui import Gui
+
+
+# Color values are enumerated
+class Color(Enum):
+    RED = 0
+    GREEN = 1
+    BLUE = 2
+
+
+# Initial selected color
+# Note that [color] is an enumeration member
+color = Color.RED
+
+page = """
+<|{color}|toggle|lov={Color}|>
+
+Selected enum: <|{str(color)}|>
+
+Selected value: <|{color.value}|>
+"""
+
+if __name__ == "__main__":
+    Gui(page).run(title="Binding - LoV as Enum")

doc/gui/examples/blocks/dialog_labels/__init__.py

@@ -0,0 +1 @@
+# This file makes this directory a module on its own, mandatory for mypy.

doc/gui/examples/blocks/dialog_labels/builder.py

@@ -0,0 +1,39 @@
+# Copyright 2021-2024 Avaiga Private Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+# -----------------------------------------------------------------------------------------
+# To execute this script, make sure that the taipy-gui package is installed in your
+# Python environment and run:
+#     python <script>
+# -----------------------------------------------------------------------------------------
+import taipy.gui.builder as tgb
+from taipy.gui import Gui
+
+show_dialog = False
+
+
+def dialog_action(state, _, payload):
+    if payload["args"][0] == 0:  # First button
+        print("Good to hear!")  # noqa: T201
+    elif payload["args"][0] == 1:  # Second button
+        print("Sorry to hear that.")  # noqa: T201
+    else:  # Close button (index == -1)
+        print("Ok bye.")  # noqa: T201
+    state.show_dialog = False
+
+
+with tgb.Page() as page:
+    with tgb.dialog("{show_dialog}", title="Welcome!", on_action=dialog_action, labels="Couldn't be better;Not my day"):  # type: ignore
+        tgb.html("h2", "Hello!")
+
+    tgb.button("Show", on_action=lambda s: s.assign("show_dialog", True))
+
+if __name__ == "__main__":
+    Gui(page).run(title="Dialog - Labels")

doc/gui/examples/blocks/dialog_labels/markdown.py

@@ -0,0 +1,40 @@
+# Copyright 2021-2024 Avaiga Private Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+# -----------------------------------------------------------------------------------------
+# To execute this script, make sure that the taipy-gui package is installed in your
+# Python environment and run:
+#     python <script>
+# -----------------------------------------------------------------------------------------
+from taipy.gui import Gui
+
+show_dialog = False
+
+
+def dialog_action(state, _, payload):
+    if payload["args"][0] == 0:  # First button
+        print("Good to hear!")  # noqa: T201
+    elif payload["args"][0] == 1:  # Second button
+        print("Sorry to hear that.")  # noqa: T201
+    else:  # Close button (index == -1)
+        print("Ok bye.")  # noqa: T201
+    state.show_dialog = False
+
+
+page = """
+<|{show_dialog}|dialog|title=Welcome!|on_action=dialog_action|labels=Couldn't be better;Not my day|
+## Hello!
+|>
+
+<|Show|button|on_action={lambda s: s.assign("show_dialog", True)}|>
+"""
+
+if __name__ == "__main__":
+    Gui(page).run(title="Dialog - Labels")

doc/gui/examples/blocks/dialog_show_hide/__init__.py

@@ -0,0 +1 @@
+# This file makes this directory a module on its own, mandatory for mypy.

doc/gui/examples/blocks/dialog_show_hide/builder.py

@@ -0,0 +1,37 @@
+# Copyright 2021-2024 Avaiga Private Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+# -----------------------------------------------------------------------------------------
+# To execute this script, make sure that the taipy-gui package is installed in your
+# Python environment and run:
+#     python <script>
+# -----------------------------------------------------------------------------------------
+import taipy.gui.builder as tgb
+from taipy.gui import Gui
+
+show_dialog = False
+
+def show(state):
+    state.show_dialog = True
+
+def hide(state):
+    state.show_dialog = False
+
+with tgb.Page() as page:
+    tgb.dialog("{show_dialog}", on_action=hide)
+    # Using a lambda function:
+    # tgb.dialog("{show_dialog}", on_action=lambda s: s.assign("show_dialog", False))
+
+    tgb.button("Show", on_action=show)
+    # Using a lambda function:
+    # tgb.button("Show", on_action=lambda s: s.assign("show_dialog", True))
+
+if __name__ == "__main__":
+    Gui(page).run(title="Dialog - Show/Hide")

doc/gui/examples/blocks/dialog_show_hide/markdown.py

@@ -0,0 +1,43 @@
+# Copyright 2021-2024 Avaiga Private Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+# -----------------------------------------------------------------------------------------
+# To execute this script, make sure that the taipy-gui package is installed in your
+# Python environment and run:
+#     python <script>
+# -----------------------------------------------------------------------------------------
+from taipy.gui import Gui
+
+show_dialog = False
+
+
+def show(state):
+    state.show_dialog = True
+
+
+def hide(state):
+    state.show_dialog = False
+
+
+# Using lambda functions instead of the show() and hide() functions
+#
+# dialog:
+# <|{show_dialog}|dialog|on_action={lambda s: s.assign("show_dialog", False)}|>
+#
+# button:
+# <|Show|button|on_action={lambda s: s.assign("show_dialog", True)}|>
+page = """
+<|{show_dialog}|dialog|on_action=hide|>
+
+<|Show|button|on_action=show|>
+"""
+
+if __name__ == "__main__":
+    Gui(page).run(title="Dialog - Show/Hide")

doc/gui/examples/builder_lambda_property.py

@@ -0,0 +1,31 @@
+# Copyright 2021-2024 Avaiga Private Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+# -----------------------------------------------------------------------------------------
+# To execute this script, make sure that the taipy-gui package is installed in your
+# Python environment and run:
+#     python <script>
+# -----------------------------------------------------------------------------------------
+import taipy.gui.builder as tgb
+from taipy.gui import Gui
+
+persons = {"Albert": 1982, "Beatrix": 1955, "Cecilia": 2003}
+
+current_year = 2024
+
+with tgb.Page() as page:
+    tgb.text("Year: ", inline=True)
+    tgb.slider("{current_year}", min=1990, max=2050, inline=True)
+
+    for name, birth_year in persons.items():
+        tgb.text(lambda current_year: f"{name} would be {current_year-birth_year}")  # noqa: B023
+
+if __name__ == "__main__":
+    Gui(page).run(title="Page Builder - Using lambdas in property values")

doc/gui/examples/charts/advanced-shapes.py → doc/gui/examples/charts/advanced_shapes.py

@@ -61,4 +61,4 @@ page = """
 
 
 if __name__ == "__main__":
-    Gui(page).run(title="Chart - Advanced - Annotations")
+    Gui(page).run(title="Chart - Advanced - Shapes")

doc/gui/examples/charts/heatmap-simple.py → doc/gui/examples/charts/heatmap_simple.py

@@ -31,4 +31,4 @@ page = """
 """
 
 if __name__ == "__main__":
-    Gui(page).run(title="Chart - Heatmap - Basic")
+    Gui(page).run(title="Chart - Heatmap - Simple")

doc/gui/examples/charts/heatmap-unequal-cell-sizes.py → doc/gui/examples/charts/heatmap_unequal_cell_sizes.py

@@ -61,4 +61,4 @@ page = """
 """
 
 if __name__ == "__main__":
-    Gui(page).run(title="Chart - Heatmap - Unequal block sizes")
+    Gui(page).run(title="Chart - Heatmap - Unequal cell sizes")

doc/gui/examples/charts/pie-styling.py → doc/gui/examples/charts/pie_styling.py

@@ -42,4 +42,4 @@ page = """
 """
 
 if __name__ == "__main__":
-    Gui(page).run(title="Chart - Pie - Style")
+    Gui(page).run(title="Chart - Pie - Styling")

doc/gui/examples/controls/file_download-dynamic-temp-file.py → doc/gui/examples/controls/file_download_dynamic_temp_file.py

@@ -75,4 +75,4 @@ Precision:
 """
 
 if __name__ == "__main__":
-    Gui(page).run(title="File Download - Dynamic content")
+    Gui(page).run(title="File Download - Temporary file")

doc/gui/examples/controls/number_simple.py

@@ -0,0 +1,25 @@
+# Copyright 2021-2024 Avaiga Private Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+# -----------------------------------------------------------------------------------------
+# To execute this script, make sure that the taipy-gui package is installed in your
+# Python environment and run:
+#     python <script>
+# -----------------------------------------------------------------------------------------
+from taipy.gui import Gui
+
+value = 50
+
+page = """
+<|{value}|number|>
+"""
+
+if __name__ == "__main__":
+    Gui(page).run(title="Number - Simple")