@openenergytools/scl-select
v2.0.1
Published
select for SCL related enumerations
Readme
<scl-select>
This is a web component meant to be used for SCL type attributes restricted to xs:enumeration. In addition to default input it allows to have a value="null" for XML type attributes.
Usage
This element was meant to be used only for plugins in this organization. If it still fills you bill please use or re-use it. But be aware that we will not react on feature wishes that do not contribute to the needs of plugin in this organization.
SclSelect.ts:
class: SclSelect, scl-select
Superclass
| Name | Module | Package |
| ------------ | ------ | ------- |
| LitElement | | lit |
Mixins
| Name | Module | Package |
| --------------------- | ------ | --------------------------------------- |
| ScopedElementsMixin | | @open-wc/scoped-elements/lit-element.js |
Static Fields
| Name | Privacy | Type | Default | Description | Inherited From |
| ---------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------ | ----------- | -------------- |
| scopedElements | | object | {
'md-switch': MdSwitch,
'md-filled-select': MdFilledSelect,
'md-select-option': MdSelectOption,
} | | |
Fields
| Name | Privacy | Type | Default | Description | Inherited From |
| ---------------- | ------- | --------------------- | ------- | ------------------------------------------------------------------------ | -------------- |
| nullable | | boolean | false | Whether [[`value`]] may be set to `null` by nullSwitch | |
| value | | string \| null | | SCL attributes `value`, can only be `null` if [[`nullable`]]. | |
| selectOptions | | string[] | [] | Value array be be renders as selection option inside the selection input | |
| disabled | | boolean | false | | |
| label | | string | '' | | |
| required | | boolean | false | | |
| supportingText | | string | '' | | |
| nullSwitch | | Switch \| undefined | | | |
Methods
| Name | Privacy | Description | Parameters | Return | Inherited From |
| ------------------- | ------- | ----------- | ----------------- | --------- | -------------- |
| reportValidity | | | | boolean | |
| setCustomValidity | | | message: string | void | |
| checkValidity | | | | boolean | |
Events
| Name | Type | Description | Inherited From |
| ------- | ------- | ----------- | -------------- |
| input | Event | | |
Fields
| Name | Privacy | Type | Default | Description | Inherited From |
| ------------- | ------- | --------------------- | ------- | ----------- | -------------- |
| selectValue | private | string | '' | | |
| isNull | private | boolean | false | | |
| parkedValue | private | string \| null | null | | |
| null | private | boolean | | | |
| selectInput | private | Select \| undefined | | | |
Methods
| Name | Privacy | Description | Parameters | Return | Inherited From |
| -------------------- | ------- | ----------- | ---------------------- | ---------------- | -------------- |
| renderNullSwitch | private | | | TemplateResult | |
| renderSelectOption | private | | selectOption: string | TemplateResult | |
Exports
| Kind | Name | Declaration | Module | Package |
| ---- | ----------- | ----------- | ------------ | ------- |
| js | SclSelect | SclSelect | SclSelect.ts | |
scl-select.ts:
Exports
| Kind | Name | Declaration | Module | Package |
| --------------------------- | ------------ | ----------- | ------------- | ------- |
| custom-element-definition | scl-select | SclSelect | /SclSelect.js | |
© 2023 The Contributors
