Skip to content

Commit 7ef8804

Browse files
PedroPovedaQandrewseguin
authored andcommitted
docs: clean up slide toggle API Docs (#13522)
* docs: clean up slide toggle API docs * fix: grammar fix
1 parent 282736f commit 7ef8804

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

src/lib/slide-toggle/slide-toggle.ts

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -127,13 +127,13 @@ export class MatSlideToggle extends _MatSlideToggleMixinBase implements OnDestro
127127
/** Reference to the thumb bar HTMLElement. */
128128
@ViewChild('toggleBar') _thumbBarEl: ElementRef;
129129

130-
/** Name value will be applied to the input element if present */
130+
/** Name value will be applied to the input element if present. */
131131
@Input() name: string | null = null;
132132

133133
/** A unique id for the slide-toggle input. If none is supplied, it will be auto-generated. */
134134
@Input() id: string = this._uniqueId;
135135

136-
/** Whether the label should appear after or before the slide-toggle. Defaults to 'after' */
136+
/** Whether the label should appear after or before the slide-toggle. Defaults to 'after'. */
137137
@Input() labelPosition: 'before' | 'after' = 'after';
138138

139139
/** Used to set the aria-label attribute on the underlying input element. */
@@ -147,7 +147,7 @@ export class MatSlideToggle extends _MatSlideToggleMixinBase implements OnDestro
147147
get required(): boolean { return this._required; }
148148
set required(value) { this._required = coerceBooleanProperty(value); }
149149

150-
/** Whether the slide-toggle element is checked or not */
150+
/** Whether the slide-toggle element is checked or not. */
151151
@Input()
152152
get checked(): boolean { return this._checked; }
153153
set checked(value) {
@@ -160,16 +160,17 @@ export class MatSlideToggle extends _MatSlideToggleMixinBase implements OnDestro
160160

161161
/**
162162
* An event will be dispatched each time the slide-toggle input is toggled.
163-
* This event always fire when user toggle the slide toggle, but does not mean the slide toggle's
164-
* value is changed. The event does not fire when user drag to change the slide toggle value.
163+
* This event is always emitted when the user toggles the slide toggle, but this does not mean
164+
* the slide toggle's value has changed. The event does not fire when the user drags to change
165+
* the slide toggle value.
165166
*/
166167
@Output() readonly toggleChange: EventEmitter<void> = new EventEmitter<void>();
167168

168169
/**
169170
* An event will be dispatched each time the slide-toggle is dragged.
170-
* This event always fire when user drag the slide toggle to make a change that greater than 50%.
171-
* It does not mean the slide toggle's value is changed. The event does not fire when user toggle
172-
* the slide toggle to change the slide toggle's value.
171+
* This event is always emitted when the user drags the slide toggle to make a change greater
172+
* than 50%. It does not mean the slide toggle's value is changed. The event is not emitted when
173+
* the user toggles the slide toggle to change its value.
173174
*/
174175
@Output() readonly dragChange: EventEmitter<void> = new EventEmitter<void>();
175176

0 commit comments

Comments
 (0)