Websites
/
lektor-website
mirror of https://github.com/lektor/lektor-website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(fix): Document use of SingleInputType base class

This commit is contained in:
Jeff Dairiki 2023-03-03 15:49:53 -08:00 committed by Jakob Schnitzer
parent 2c0b21d33d
commit fa73e1db27
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
content/docs/api/db/type/contents.lr
View File

@ -28,9 +28,9 @@ needs to be called `MyThingType`. Afterwards you can register it with the
environment in [setup_env :ref](../../plugins/events/setup-env/): environment in [setup_env :ref](../../plugins/events/setup-env/):
```python ```python
from lektor.types import Type from lektor.types.primitives import SingleInputType
class MyThingType(Type): class MyThingType(SingleInputType):
widget = 'singleline-text' widget = 'singleline-text'
def value_from_raw(self, raw): def value_from_raw(self, raw):
@ -40,6 +40,11 @@ def setup_env(self, **extra):
self.env.add_type(MyThingType) self.env.add_type(MyThingType)
``` ```
!!! In the above example, the new type declares a base class of `SingleInputType`.
This is appropriate for types that use a single-line input widget in the admin UI —
it enables the use of the `addon_label` [field option :ref](/docs/models/#fields).
Custom types that use more general input types should instead inherit from `lektor.types.base.Type`.
For more information see [value_from_raw :ref](value-from-raw/). For more information see [value_from_raw :ref](value-from-raw/).
There is a more complete example in the There is a more complete example in the

5
content/docs/plugins/howto/contents.lr
View File

@ -187,3 +187,8 @@ class AsciiDocPlugin(Plugin):
# Derives type name "asciidoc" from class name. # Derives type name "asciidoc" from class name.
self.env.add_type(AsciiDocType) self.env.add_type(AsciiDocType)
``` ```
### Base Classes
In the general case, new types should inherit from `lektor.types.base.Type`.
However, when creating a new type that will use a "single-line" input widget in the Admin GUI, inheriting from `lektor.types.primitives.SingleInputType` will enable the use of the `addon_label` [field option :ref](/docs/models/#fields).