openscd / oscd-form-elements Goto Github PK

As a plugin author and maintainer of already existing plugins, I need to have open-scds wizard-textfield available through npm. The idea is to re-use the component for other plug-ins editors. This behavior is the same all over OpenSCD.

Requirements:

• move wizard-textfield to oscd-texfield repo
• change tag name to oscd-textfield
• do !NOT! extend from mwc-textfield but use it in the render method
• add properties
• This wizard is only for 61850 SCL related fields

name	type	description
value	string | null	former maybeValue set and get Elements attribute value null means attribute is missing
disabled	boolean	disables both the input field and the null switch
defaultValue	string	is indicating the default value if maybeValue is null
unit	string	indicator when multiplier can be selected
multipliers	(string | null)[]	an array of allowed multipliers the user can choose from
multiplier	string | null	multiplier attribute the user can choose from
label	string	pass to mwc-textfield
required	boolean	pass to input field
reservedValues	string[]	and array of invalid inputs
nullable	boolean	Whether null is valid maybeValue output
helper	string	pass to input field
helperPersistent	boolean	pass to input field
validationMessage	string	pass to input field helper if input is invalid
suffix	boolean	pass to input field
pattern	string	pass to input field
minLength	string	pass to input field
maxLength	string	pass to input field
type	string	pass to input field
min	string	pass to input field
max	string	pass to input field

• expose methods

name	type	description
checkValidity	boolean	Whether the select field is valid

• add change event
  propagate change event for any changes on value

• add screenshot tests

• add storybook

Additional Information
This web-component is used pretty much everywhere in the software

Open questions:
Why is multiplier in their? Answer: it could happen on the SCL field;

Styling?
Error handling?

General question for OSCD-textfield, OSCD-select, OSCD-testfield;
if you enter that does not meet the criteria; it becomes red;

Do you need to add translations to the wizard-textfield

Do we need a one-to-one conversion?
Yes: faster to production
No: fix bugs first

Decision: Fix bugs

As a plugin author and maintainer of already existing plugins, I need to have open-scds wizard-select available through nmp.

Requirements:

• move wizard-select to oscd-select repo
• change tag name to oscd-select
• do !NOT! extend from mwc-select but use it in the render method. This allows us to exchange the now used material web components with another web-component library.
• add properties

name	type	description
value	string | null	set and get Elements attribute value null means attribute is missing
disabled	boolean	disables both the input field and the null switch
defaultValue	string	is indicating the default value if maybeValue is null
label	string	pass to mwc-select
required	boolean	pass to input field
nullable	boolean	Whether null is valid maybeValue output
helper	string	pass to input field
validationMessage	string	pass to input field helper if input is invalid
selected	ListItemBase|null	Selected list item element.
items	ListItemBase[]	List of selectable items.
index	number	Index of selected list item.

• expose methods

name	type	description
checkValidity	boolean	Whether the select field is valid

• propagate event
  change event for any changes on value

• add screenshot tests

• add storybook

Additional Information
This web-component is used pretty much everywhere in the software

As a plugin author and maintainer of already existing plugins, I need to have open-scds wizard-checkbox available through nmp.

Requirements:

• move wizard-textfield to oscd-checkbox repo
• change tag name to oscd-checkbox
• do !NOT! extend from mwc-checkbox but use it in the render method
• add properties

name	type	description
maybeValue	string | null	set and get Elements attribute value null means attribute is missing
disabled	boolean	disables both the input field and the null switch
defaultValue	string	is indicating the default value if maybeValue is null
label	string	short name displayed next to the checkbox
nullable	boolean	Whether null is valid maybeValue output
helper	string	pass to input field

• propagate change event for any changes on maybeValue
• add screenshot tests
• add storybook

Additional Information
This web-component is used pretty much everywhere in the software