Преглед изворни кода

Add comments to html metadata component (#3731)

Alek Petuskey пре 10 месеци
родитељ
комит
76627c2076
2 измењених фајлова са 39 додато и 1 уклоњено
  1. 26 1
      reflex/components/el/elements/metadata.py
  2. 13 0
      reflex/components/el/elements/metadata.pyi

+ 26 - 1
reflex/components/el/elements/metadata.py

@@ -29,24 +29,49 @@ class Link(BaseHTML):  # noqa: E742
 
 
     tag = "link"
     tag = "link"
 
 
+    # Specifies the CORS settings for the linked resource
     cross_origin: Var[Union[str, int, bool]]
     cross_origin: Var[Union[str, int, bool]]
+
+    # Specifies the URL of the linked document/resource
     href: Var[Union[str, int, bool]]
     href: Var[Union[str, int, bool]]
+
+    # Specifies the language of the text in the linked document
     href_lang: Var[Union[str, int, bool]]
     href_lang: Var[Union[str, int, bool]]
+
+    # Allows a browser to check the fetched link for integrity
     integrity: Var[Union[str, int, bool]]
     integrity: Var[Union[str, int, bool]]
+
+    # Specifies on what device the linked document will be displayed
     media: Var[Union[str, int, bool]]
     media: Var[Union[str, int, bool]]
+
+    # Specifies the referrer policy of the linked document
     referrer_policy: Var[Union[str, int, bool]]
     referrer_policy: Var[Union[str, int, bool]]
+
+    # Specifies the relationship between the current document and the linked one
     rel: Var[Union[str, int, bool]]
     rel: Var[Union[str, int, bool]]
+
+    # Specifies the sizes of icons for visual media
     sizes: Var[Union[str, int, bool]]
     sizes: Var[Union[str, int, bool]]
+
+    # Specifies the MIME type of the linked document
     type: Var[Union[str, int, bool]]
     type: Var[Union[str, int, bool]]
 
 
 
 
 class Meta(BaseHTML):  # Inherits common attributes from BaseHTML
 class Meta(BaseHTML):  # Inherits common attributes from BaseHTML
     """Display the meta element."""
     """Display the meta element."""
 
 
-    tag = "meta"
+    tag = "meta"  # The HTML tag for this element is <meta>
+
+    # Specifies the character encoding for the HTML document
     char_set: Var[Union[str, int, bool]]
     char_set: Var[Union[str, int, bool]]
+
+    # Defines the content of the metadata
     content: Var[Union[str, int, bool]]
     content: Var[Union[str, int, bool]]
+
+    # Provides an HTTP header for the information/value of the content attribute
     http_equiv: Var[Union[str, int, bool]]
     http_equiv: Var[Union[str, int, bool]]
+
+    # Specifies a name for the metadata
     name: Var[Union[str, int, bool]]
     name: Var[Union[str, int, bool]]
 
 
 
 

+ 13 - 0
reflex/components/el/elements/metadata.pyi

@@ -346,6 +346,15 @@ class Link(BaseHTML):
 
 
         Args:
         Args:
             *children: The children of the component.
             *children: The children of the component.
+            cross_origin: Specifies the CORS settings for the linked resource
+            href: Specifies the URL of the linked document/resource
+            href_lang: Specifies the language of the text in the linked document
+            integrity: Allows a browser to check the fetched link for integrity
+            media: Specifies on what device the linked document will be displayed
+            referrer_policy: Specifies the referrer policy of the linked document
+            rel: Specifies the relationship between the current document and the linked one
+            sizes: Specifies the sizes of icons for visual media
+            type: Specifies the MIME type of the linked document
             access_key:  Provides a hint for generating a keyboard shortcut for the current element.
             access_key:  Provides a hint for generating a keyboard shortcut for the current element.
             auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
             auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
             content_editable: Indicates whether the element's content is editable.
             content_editable: Indicates whether the element's content is editable.
@@ -466,6 +475,10 @@ class Meta(BaseHTML):
 
 
         Args:
         Args:
             *children: The children of the component.
             *children: The children of the component.
+            char_set: Specifies the character encoding for the HTML document
+            content: Defines the content of the metadata
+            http_equiv: Provides an HTTP header for the information/value of the content attribute
+            name: Specifies a name for the metadata
             access_key:  Provides a hint for generating a keyboard shortcut for the current element.
             access_key:  Provides a hint for generating a keyboard shortcut for the current element.
             auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
             auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
             content_editable: Indicates whether the element's content is editable.
             content_editable: Indicates whether the element's content is editable.