adding async functions to search index

website/build_search_index.py

@@ -3,8 +3,9 @@ import ast
 import json
 import os
 import re
+from _ast import AsyncFunctionDef
 from pathlib import Path
-from typing import List, Optional, Union
+from typing import Any, List, Optional, Union
 
 from icecream import ic
 
@@ -66,6 +67,9 @@ class DocVisitor(ast.NodeVisitor):
             self.add_to_search_index(self.current_title, self.current_content if self.current_content else 'Overview')
             self.current_content = []
 
+    def visit_AsyncFunctionDef(self, node: AsyncFunctionDef) -> None:
+        self.visit_FunctionDef(node)
+
     def visit_FunctionDef(self, node: ast.FunctionDef) -> None:
         if node.name == 'main_demo':
             docstring = ast.get_docstring(node)
@@ -77,11 +81,13 @@ class DocVisitor(ast.NodeVisitor):
 
         for decorator in node.decorator_list:
             if isinstance(decorator, ast.Call):
+                ic(decorator.func)
                 function = decorator.func
                 if isinstance(function, ast.Name) and function.id == 'text_demo':
                     title = decorator.args[0].s
                     content = cleanup(decorator.args[1].s).splitlines()
                     self.add_to_search_index(title, content)
+        ic(node.name)
         self.generic_visit(node)
 
     def add_to_search_index(self, title: str, content: Union[str, list], main: bool = False) -> None:
@@ -124,6 +130,7 @@ class MainVisitor(ast.NodeVisitor):
 
 def generate_for(file: Path, topic: Optional[str] = None) -> None:
     with open(file, 'r') as source:
+        ic(file)
         tree = ast.parse(source.read())
         doc_visitor = DocVisitor(topic)
         doc_visitor.visit(tree)

website/static/search_index.json

@@ -309,6 +309,16 @@
     "content": "This element is based on Quasar's QIcon <https://quasar.dev/vue-components/icon>_ component.  Here <https://material.io/icons/>_ is a reference of possible names.  :param name: name of the icon :param size: size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl), examples: 16px, 2rem :param color: icon color (either a Quasar, Tailwind, or CSS color or None, default: None)",
     "url": "/documentation/icon"
   },
+  {
+    "title": "Icon: Eva icons",
+    "content": "You can use Eva icons in your app.",
+    "url": "/documentation/icon#eva_icons"
+  },
+  {
+    "title": "Icon: Lottie files",
+    "content": "You can also use Lottie files with animations.",
+    "url": "/documentation/icon#lottie_files"
+  },
   {
     "title": "Download",
     "content": "Function to trigger the download of a file.  :param url: target URL of the file to download :param filename: name of the file to download (default: name of the file on the server)",
@@ -349,6 +359,16 @@
     "content": "This element is based on Quasar's QBtn <https://quasar.dev/vue-components/button>_ component.  The `color parameter accepts a Quasar color, a Tailwind color, or a CSS color. If a Quasar color is used, the button will be styled according to the Quasar theme including the color of the text. Note that there are colors like \"red\" being both a Quasar color and a CSS color. In such cases the Quasar color will be used.  :param text: the label of the button :param on_click: callback which is invoked when button is pressed :param color: the color of the button (either a Quasar, Tailwind, or CSS color or None`, default: 'primary')",
     "url": "/documentation/button"
   },
+  {
+    "title": "Button: Icons",
+    "content": "You can also add an icon to a button.",
+    "url": "/documentation/button#icons"
+  },
+  {
+    "title": "Button: Await button click",
+    "content": "Sometimes it is convenient to wait for a button click before continuing the execution.",
+    "url": "/documentation/button#await_button_click"
+  },
   {
     "title": "Spinner",
     "content": "See Quasar Spinner <https://quasar.dev/vue-components/spinners>_ for more information.  :param type: type of spinner (e.g. \"audio\", \"ball\", \"bars\", ..., default: \"default\") :param size: size of the spinner (e.g. \"3em\", \"10px\", \"xl\", ..., default: \"1em\") :param color: color of the spinner (either a Quasar, Tailwind, or CSS color or None, default: \"primary\") :param thickness: thickness of the spinner (applies to the \"default\" spinner only, default: 5.0)",
@@ -479,6 +499,21 @@
     "content": "This element is based on Quasar's QInput <https://quasar.dev/vue-components/input>_ component.  The on_change event is called on every keystroke and the value updates accordingly. If you want to wait until the user confirms the input, you can register a custom event callback, e.g. ui.input(...).on('keydown.enter', ...) or ui.input(...).on('blur', ...).  You can use the validation parameter to define a dictionary of validation rules. The key of the first rule that fails will be displayed as an error message.  :param label: displayed label for the text input :param placeholder: text to show if no value is entered :param value: the current value of the text input :param password: whether to hide the input (default: False) :param password_toggle_button: whether to show a button to toggle the password visibility (default: False) :param on_change: callback to execute when the value changes :param autocomplete: optional list of strings for autocompletion :param validation: dictionary of validation rules, e.g. `'Too short!': lambda value: len(value) < 3`",
     "url": "/documentation/input"
   },
+  {
+    "title": "Input: Autocompletion",
+    "content": "The autocomplete feature provides suggestions as you type, making input easier and faster. The parameter options is a list of strings that contains the available options that will appear.",
+    "url": "/documentation/input#autocompletion"
+  },
+  {
+    "title": "Input: Clearable",
+    "content": "The clearable prop from Quasar adds a button to the input that clears the text.",
+    "url": "/documentation/input#clearable"
+  },
+  {
+    "title": "Input: Styling",
+    "content": "Quasar has a lot of props to change the appearance. It is even possible to style the underlying input with input-style and input-class props and use the provided slots to add custom elements.",
+    "url": "/documentation/input#styling"
+  },
   {
     "title": "Chart",
     "content": "An element to create a chart using Highcharts <https://www.highcharts.com/>_. Updates can be pushed to the chart by changing the options property. After data has changed, call the update method to refresh the chart.  By default, a Highcharts.chart is created. To use, e.g., Highcharts.stockChart instead, set the type property to \"stockChart\".  :param options: dictionary of Highcharts options :param type: chart type (e.g. \"chart\", \"stockChart\", \"mapChart\", ...; default: \"chart\") :param extras: list of extra dependencies to include (e.g. \"annotations\", \"arc-diagram\", \"solid-gauge\", ...)",
@@ -649,6 +684,11 @@
     "content": "This element is based on Quasar's QInput <https://quasar.dev/vue-components/input>_ component. The `type is set to textarea to create a multi-line text input.  :param label: displayed name for the textarea :param placeholder: text to show if no value is entered :param value: the initial value of the field :param on_change: callback to execute when the value changes :param validation: dictionary of validation rules, e.g. 'Too short!': lambda value: len(value) < 3`",
     "url": "/documentation/textarea"
   },
+  {
+    "title": "Textarea: Clearable",
+    "content": "The clearable prop from Quasar adds a button to the input that clears the text.",
+    "url": "/documentation/textarea#clearable"
+  },
   {
     "title": "Video",
     "content": ":param src: URL of the video source :param controls: whether to show the video controls, like play, pause, and volume (default: True) :param autoplay: whether to start playing the video automatically (default: False) :param muted: whether the video should be initially muted (default: False) :param loop: whether the video should loop (default: False)  See here <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#events>_ for a list of events you can subscribe to using the generic event subscription on().",
@@ -724,6 +764,11 @@
     "content": "Displays an image.  :param source: the source of the image; can be a URL or a base64 string",
     "url": "/documentation/image"
   },
+  {
+    "title": "Image: Lottie files",
+    "content": "You can also use Lottie files with animations.",
+    "url": "/documentation/image#lottie_files"
+  },
   {
     "title": "Color Theming",
     "content": "Sets the main colors (primary, secondary, accent, ...) used by Quasar <https://quasar.dev/>_.",
@@ -734,6 +779,11 @@
     "content": "This element is based on Quasar's QInput <https://quasar.dev/vue-components/input>_ component.  You can use the validation parameter to define a dictionary of validation rules. The key of the first rule that fails will be displayed as an error message.  :param label: displayed name for the number input :param placeholder: text to show if no value is entered :param value: the initial value of the field :param min: the minimum value allowed :param max: the maximum value allowed :param step: the step size for the stepper buttons :param prefix: a prefix to prepend to the displayed value :param suffix: a suffix to append to the displayed value :param format: a string like \"%.2f\" to format the displayed value :param on_change: callback to execute when the value changes :param validation: dictionary of validation rules, e.g. `'Too small!': lambda value: value < 3`",
     "url": "/documentation/number"
   },
+  {
+    "title": "Number: Clearable",
+    "content": "The clearable prop from Quasar adds a button to the input that clears the text.",
+    "url": "/documentation/number#clearable"
+  },
   {
     "title": "Dropdown Selection",
     "content": "The options can be specified as a list of values, or as a dictionary mapping values to labels. After manipulating the options, call update() to update the options in the UI.  :param options: a list ['value1', ...] or dictionary 'value1':'label1', ... specifying the options :param value: the initial value :param on_change: callback to execute when selection changes :param with_input: whether to show an input field to filter the options :param multiple: whether to allow multiple selections",
@@ -809,6 +859,11 @@
     "content": "You can also include key modifiers (shown in input \"A\"), modifier combinations (shown in input \"B\"), and event modifiers (shown in input \"C\").",
     "url": "/documentation/generic_events#modifiers"
   },
+  {
+    "title": "Generic Events: Custom events",
+    "content": "It is fairly easy to emit custom events from JavaScript which can be listened to with element.on(...). This can be useful if you want to call Python code when something happens in JavaScript. In this example we are listening to the visibilitychange event of the browser tab.",
+    "url": "/documentation/generic_events#custom_events"
+  },
   {
     "title": "Pyplot Context",
     "content": "Create a context to configure a Matplotlib <https://matplotlib.org/>_ plot.  :param close: whether the figure should be closed after exiting the context; set to False if you want to update it later (default: True) :param kwargs: arguments like figsize which should be passed to pyplot.figure <https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.figure.html>_",