You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/template_usage.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ First template
5
5
--------------
6
6
7
7
When building larger UI's it may be convenient to write composite widgets using
8
-
the Vue template syntax. Lets start with a basic example:
8
+
the Vue template syntax. Let's start with a basic example:
9
9
10
10
.. jupyter-execute::
11
11
@@ -87,7 +87,7 @@ Template in vue files
87
87
88
88
Although a powerful feature, programming Vue templates in a string is quite
89
89
cumbersome, since you lose syntax highlighting and other advanced editor
90
-
features. Instead, we can put out Vue template into a ``.vue`` file, and point
90
+
features. Instead, we can put our Vue template into a ``.vue`` file, and point
91
91
our VuetifyTemplate to it.
92
92
93
93
@@ -150,7 +150,7 @@ A demonstration in a screen capture:
150
150
151
151
152
152
.. note::
153
-
For this feature we require the watchdog packages. Install it using ``pip install "watchdog>=2.0"`` or ``conda install -c conda-forge "watchdog>=2.0"``
153
+
For this feature we require the watchdog package. Install it using ``pip install "watchdog>=2.0"`` or ``conda install -c conda-forge "watchdog>=2.0"``
Some attribute have naming conflicts with Python or ipywidgets. These are :code:`for`, :code:`open`, :code:`class` and
81
+
Some attributes have naming conflicts with Python or ipywidgets. These are :code:`for`, :code:`open`, :code:`class` and
82
82
:code:`style` and must be suffixed with an underscore. For example :code:`style` becomes :code:`style_`
83
83
84
84
Vuetify:
@@ -101,7 +101,7 @@ see an example of this. To look at how that variable is initialized you select t
101
101
If it's an expression it's mostly used to set a List or a Dict, as is done with :code:`items` in the examples above.
102
102
This can be the same in ipyvuetify.
103
103
104
-
for non-vuetify related attributes, the ones from the HTML tag, can be accessed through the :code:`attributes` trait.
104
+
For non-vuetify related attributes, the ones from the HTML tag, can be accessed through the :code:`attributes` trait.
105
105
106
106
Vuetify:
107
107
@@ -256,7 +256,7 @@ All `HTML events <https://www.w3schools.com/tags/ref_eventattributes.asp>`_ can
256
256
omitted.
257
257
258
258
Widgets can have custom events, to find out which, the `Vuetify API explorer
259
-
<https://v2.vuetifyjs.com/components/api-explorer/>`_ can be used. Search for a component and on the left-hand side of list
259
+
<https://v2.vuetifyjs.com/components/api-explorer/>`_ can be used. Search for a component and on the left-hand side of the list
260
260
of attributes you will find a tab for the events.
261
261
262
262
In Vuetify events are defined as attributes with an :code:`@` prefix. The equivalent Vuetify syntax of the example above
@@ -341,7 +341,7 @@ And colors:
341
341
ClassList attribute
342
342
^^^^^^^^^^^^^^^^^^^
343
343
344
-
The :code:`class` attribute of a Vuetify DOM elements give access to the built-in styles of the lib. See the `vuetify site <https://v2.vuetifyjs.com/en/styles/colors/>`__ to know more about available styling class. As mentioned in the previous section this can be set using the :code:`class_` member of the widget. In addition, ipyvuetify provides a :code:`class_list` member that works the same way as the `MDN classList property <https://developer.mozilla.org/en-US/docs/Web/API/Element/classList>`__. It embeds the following methods:
344
+
The :code:`class` attribute of Vuetify DOM elements gives access to the built-in styles of the library. See the `Vuetify site <https://v2.vuetifyjs.com/en/styles/colors/>`__ to learn more about available styling classes. As mentioned in the previous section this can be set using the :code:`class_` member of the widget. In addition, ipyvuetify provides a :code:`class_list` member that works the same way as the `MDN classList property <https://developer.mozilla.org/en-US/docs/Web/API/Element/classList>`__. It embeds the following methods:
345
345
346
346
- :code:`add(*args)`: add class elements to the class\_ trait of the widget
347
347
@@ -378,7 +378,7 @@ The :code:`class` attribute of a Vuetify DOM elements give access to the built-i
378
378
Visibility
379
379
^^^^^^^^^^
380
380
381
-
ipyvuetify widgets visibility can be changed using the built-in methods :code:`hide()` and :code:`show()`.
381
+
ipyvuetify widget visibility can be changed using the built-in methods :code:`hide()` and :code:`show()`.
382
382
Using :code:`hide` will add the :code:`d-none` class to the widget and :code:`show` will remove it, hiding and showing the widget to the end user without removing it from the notebook.
383
383
384
384
.. jupyter-execute::
@@ -505,11 +505,11 @@ translation from Vuetify examples to ipyvuetify.
505
505
506
506
- Component names convert to CamelCase and the v- prefix is stripped
507
507
508
-
+------------+------------------------+
509
-
| Vuetify | ``<v-list-tile .../>`` |
510
-
+------------+------------------------+
511
-
| ipyvuetify | ``ListTitle(...)`` |
512
-
+------------+------------------------+
508
+
+------------+------------------------------+
509
+
| Vuetify | ``<v-list-item-title .../>`` |
510
+
+------------+------------------------------+
511
+
| ipyvuetify | ``ListItemTitle(...)``|
512
+
+------------+------------------------------+
513
513
514
514
- Attributes
515
515
@@ -523,11 +523,11 @@ translation from Vuetify examples to ipyvuetify.
523
523
524
524
- must have a value
525
525
526
-
+------------+------------------------+
527
-
| Vuetify | ``<v-btn round ...`` |
528
-
+------------+------------------------+
529
-
| ipyvuetify | ``Btn(round=True ...`` |
530
-
+------------+------------------------+
526
+
+------------+--------------------------+
527
+
| Vuetify | ``<v-btn rounded ...`` |
528
+
+------------+--------------------------+
529
+
| ipyvuetify | ``Btn(rounded=True ...`` |
530
+
+------------+--------------------------+
531
531
532
532
- with naming conflicts, ``style``, ``class``, ``open`` and ``for``, are suffixed with an ``_``
533
533
@@ -565,7 +565,7 @@ translation from Vuetify examples to ipyvuetify.
0 commit comments