From 76a64bce1a893c21f4200180808628242b1fa104 Mon Sep 17 00:00:00 2001 From: Elijah Ahianyo Date: Fri, 9 Jun 2023 19:10:25 +0000 Subject: [PATCH] Component props docs update (#1176) --- pynecone/components/forms/switch.py | 4 ++-- pynecone/components/forms/textarea.py | 2 +- pynecone/components/layout/box.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/pynecone/components/forms/switch.py b/pynecone/components/forms/switch.py index a99103fa1..d947c2df6 100644 --- a/pynecone/components/forms/switch.py +++ b/pynecone/components/forms/switch.py @@ -11,13 +11,13 @@ class Switch(ChakraComponent): tag = "Switch" - # If true, the switch will be checked. You'll need to pass onChange to update its value (since it is now controlled) + # If true, the switch will be checked. You'll need to set an on_change event handler to update its value (since it is now controlled) is_checked: Var[bool] # If true, the switch will be disabled is_disabled: Var[bool] - # If true and isDisabled is passed, the switch will remain tabbable but not interactive + # If true and is_disabled prop is set, the switch will remain tabbable but not interactive. is_focusable: Var[bool] # If true, the switch is marked as invalid. Changes style of unchecked state. diff --git a/pynecone/components/forms/textarea.py b/pynecone/components/forms/textarea.py index 8860470cb..0b7b64a69 100644 --- a/pynecone/components/forms/textarea.py +++ b/pynecone/components/forms/textarea.py @@ -33,7 +33,7 @@ class TextArea(ChakraComponent): # If true, the form control will be invalid. is_invalid: Var[bool] - # If true, the form control will be readonly. + # If true, the form control will be read-only. is_read_only: Var[bool] # If true, the form control will be required. diff --git a/pynecone/components/layout/box.py b/pynecone/components/layout/box.py index 4e3db0c9c..d4b205e90 100644 --- a/pynecone/components/layout/box.py +++ b/pynecone/components/layout/box.py @@ -10,7 +10,7 @@ class Box(ChakraComponent): tag = "Box" - # The type element to render. You can specify as an image, video, or any other HTML element such as iframe. + # The type element to render. You can specify an image, video, or any other HTML element such as iframe. element: Var[str] # The source of the content.