docs: added toggle documentation #791
Conversation
| @ViewChild('input') | ||
| inputElement: ElementRef<HTMLInputElement>; | ||
|
|
||
| /** @Input The size of the toggle. |
There was a problem hiding this comment.
@input is not needed anymore, I upgraded the docs script a week ago or so :)
|
Deploy preview for fundamental-ngx ready! Built with commit b1dc724 |
| @Input() | ||
| checked: boolean = false; | ||
|
|
||
| /** @Input aria-label attribute. */ |
There was a problem hiding this comment.
Specify that this is the aria-label of the inner input element
| @Input() | ||
| ariaLabel: string = null; | ||
|
|
||
| /** @Input aria-labelledby attribute. */ |
There was a problem hiding this comment.
specify that this is the aria-labelledby of the inner input element
| @Input() | ||
| ariaLabelledby: string = null; | ||
|
|
||
| /** @Output Event fired when the toggle is checked. */ |
There was a problem hiding this comment.
It is fired when the state of the toggle changes, whether it is checked or unchecked. Also explain that $event can be used to retrieve the new state of the toggle
| public focus(): void { | ||
| this.inputElement.nativeElement.focus(); | ||
| } | ||
|
|
||
| /** Get the innerInputId property of the toggle. */ |
There was a problem hiding this comment.
Maybe simpler: Get the id of the inner input element of the toggle.
| set isChecked(value) { | ||
| this.checked = value; | ||
| this.onChange(value); | ||
| this.onTouched(); | ||
| this.checkedChange.emit(value); | ||
| } | ||
|
|
||
| /** | ||
| * @param value Sets the value of the *checked* property of the toggle. | ||
| */ | ||
| writeValue(value: any) { |
There was a problem hiding this comment.
Can add @hidden here since this is only used by angular forms, but keep the description as it could be useful
| registerOnTouched(fn) { | ||
| this.onTouched = fn; | ||
| } | ||
|
|
||
| /** | ||
| * @param isDisabled Sets the value of the *disabled* property of the toggle. | ||
| */ | ||
| setDisabledState(isDisabled: boolean): void { |
There was a problem hiding this comment.
Also add @hidden here since this is only used by angular forms
Please provide a link to the associated issue.
#696
Please provide a brief summary of this pull request.
Documented Toggle component