Get docs working again

- Avoid the whole thing breaking when one class is bad (still no idea why)
- Add some missing documentation
This commit is contained in:
nathan 2024-02-20 16:20:00 -07:00
parent ab27bcd823
commit e7d66f22e6
3 changed files with 14 additions and 3 deletions

View File

@ -15,7 +15,7 @@ import {cleanSelectOptions, find_select_options, SelectOption} from "./FindSelec
import {SearchMixinInterface} from "./SearchMixin"; import {SearchMixinInterface} from "./SearchMixin";
/** /**
* Base class for things that do selectbox type behaviour, to avoid putting too much or copying into read-only * @summary Base class for things that do selectbox type behaviour, to avoid putting too much or copying into read-only
* selectboxes, also for common handling of properties for more special selectboxes. * selectboxes, also for common handling of properties for more special selectboxes.
* *
* As with most other widgets that extend Shoelace components, do not override render() without good reason. * As with most other widgets that extend Shoelace components, do not override render() without good reason.
@ -53,6 +53,12 @@ type Constructor<T = {}> = new (...args : any[]) => T;
export const Et2WidgetWithSelectMixin = <T extends Constructor<LitElement>>(superclass : T) => export const Et2WidgetWithSelectMixin = <T extends Constructor<LitElement>>(superclass : T) =>
{ {
/**
* @summary Mixin for widgets where you can select from a pre-defined list of options
*
* Sample text
*
*/
class Et2WidgetWithSelect extends Et2InputWidget(superclass) class Et2WidgetWithSelect extends Et2InputWidget(superclass)
{ {
/** /**
@ -117,7 +123,6 @@ export const Et2WidgetWithSelectMixin = <T extends Constructor<LitElement>>(supe
return result; return result;
} }
/** @param {import('@lion/core').PropertyValues } changedProperties */
updated(changedProperties : PropertyValues) updated(changedProperties : PropertyValues)
{ {
super.updated(changedProperties); super.updated(changedProperties);

View File

@ -47,7 +47,7 @@ import {Et2VfsPath} from "./Et2VfsPath";
* @event change - Emitted when the control's value changes. * @event change - Emitted when the control's value changes.
* *
* @csspart toolbar - controls at the top * @csspart toolbar - controls at the top
* @csspart path * @csspart path - Et2VfsPath control
* @csspart listbox - The list of files * @csspart listbox - The list of files
* @csspart mimefilter - Mime filter select * @csspart mimefilter - Mime filter select
* @csspart form-control-help-text - The help text's wrapper. * @csspart form-control-help-text - The help text's wrapper.

View File

@ -6,6 +6,9 @@
{% set component = getComponent(component.tagName) %} {% set component = getComponent(component.tagName) %}
{% block content %} {% block content %}
{# Avoid breaking if the component is not correct #}
{% if component and component.tagName %}
{# Determine the badge variant #} {# Determine the badge variant #}
{% if component.status == 'stable' %} {% if component.status == 'stable' %}
{% set badgeVariant = 'primary' %} {% set badgeVariant = 'primary' %}
@ -324,4 +327,7 @@
{% endfor %} {% endfor %}
</ul> </ul>
{% endif %} {% endif %}
{% else %}
This component is not correctly documented
{% endif %}
{% endblock %} {% endblock %}