Skip to content

Commit dbd1f26

Browse files
jayvdbandrewseguin
authored andcommitted
docs: fix spelling (#25296)
(cherry picked from commit df2eb8b)
1 parent 1dfa40b commit dbd1f26

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+84
-84
lines changed

guides/theming.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,7 @@ Angular Material supports rendering highly visible outlines on focused elements.
385385
enable these strong focus indicators via two Sass mixins:
386386
`strong-focus-indicators` and `strong-focus-indicators-theme`.
387387

388-
The `strong-focus-indicators` mixin emits structal indicator styles for all components. This mixin
388+
The `strong-focus-indicators` mixin emits structural indicator styles for all components. This mixin
389389
should be included exactly once in an application, similar to the `core` mixin described above.
390390

391391
The `strong-focus-indicators-theme` mixin emits only the indicator's color styles. This mixin should

guides/typography.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ for the library's components. Additionally, Angular Material provides APIs for a
88
styles to elements in your own application.
99

1010
Angular Material's theming APIs are built with [Sass](https://sass-lang.com). This document assumes
11-
familiary with CSS and Sass basics, including variables, functions, and mixins.
11+
familiarity with CSS and Sass basics, including variables, functions, and mixins.
1212

1313
[theming-system]: https://material.angular.io/guide/theming
1414

scripts/check-mdc-tests-config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ export const config = {
175175
// The MDC slide toggle uses a `button` which isn't able to block form submission.
176176
'should prevent the form from submit when being required',
177177

178-
// TODO: the focus origin functionality has to be implemeted for the MDC slide toggle.
178+
// TODO: the focus origin functionality has to be implemented for the MDC slide toggle.
179179
'should not change focus origin if origin not specified',
180180
],
181181
'mdc-snack-bar': [

src/cdk-experimental/column-resize/resize-strategy.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ export abstract class ResizeStrategy {
6969
}
7070

7171
/**
72-
* The optimially performing resize strategy for <table> elements with table-layout: fixed.
72+
* The optimally performing resize strategy for <table> elements with table-layout: fixed.
7373
* Tested against and outperformed:
7474
* CSS selector
7575
* CSS selector w/ CSS variable

src/cdk-experimental/popover-edit/edit-event-dispatcher.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ export class EditEventDispatcher<R> {
191191
this._editRef = ref;
192192
}
193193

194-
/** Unsets the currently active EditRef, if the specified editRef is active. */
194+
/** Unset the currently active EditRef, if the specified editRef is active. */
195195
unsetActiveEditRef(ref: R) {
196196
if (this._editRef !== ref) {
197197
return;

src/cdk-experimental/popover-edit/table-directives.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ export class CdkEditable implements AfterViewInit, OnDestroy {
145145
)
146146
.subscribe(this.editEventDispatcher.editing);
147147

148-
// Keydown must be used here or else key autorepeat does not work properly on some platforms.
148+
// Keydown must be used here or else key auto-repeat does not work properly on some platforms.
149149
fromEvent<KeyboardEvent>(element, 'keydown')
150150
.pipe(takeUntil(this.destroyed))
151151
.subscribe(this.focusDispatcher.keyObserver);

src/cdk-experimental/scrolling/auto-size-virtual-scroll.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ export class AutoSizeVirtualScrollStrategy implements VirtualScrollStrategy {
210210
if (scrollDelta < 0) {
211211
// The content offset we would expect based on the average item size.
212212
const predictedOffset = renderedRange.start * this._averager.getAverageItemSize();
213-
// The difference between the predicted size of the unrendered content at the beginning and
213+
// The difference between the predicted size of the un-rendered content at the beginning and
214214
// the actual available space to scroll over. We need to reduce this to zero by the time the
215215
// user scrolls to the top.
216216
// - 0 indicates that the predicted size and available space are the same.

src/cdk/a11y/live-announcer/live-announcer.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -50,23 +50,23 @@ export class LiveAnnouncer implements OnDestroy {
5050
}
5151

5252
/**
53-
* Announces a message to screenreaders.
54-
* @param message Message to be announced to the screenreader.
53+
* Announces a message to screen readers.
54+
* @param message Message to be announced to the screen reader.
5555
* @returns Promise that will be resolved when the message is added to the DOM.
5656
*/
5757
announce(message: string): Promise<void>;
5858

5959
/**
60-
* Announces a message to screenreaders.
61-
* @param message Message to be announced to the screenreader.
60+
* Announces a message to screen readers.
61+
* @param message Message to be announced to the screen reader.
6262
* @param politeness The politeness of the announcer element.
6363
* @returns Promise that will be resolved when the message is added to the DOM.
6464
*/
6565
announce(message: string, politeness?: AriaLivePoliteness): Promise<void>;
6666

6767
/**
68-
* Announces a message to screenreaders.
69-
* @param message Message to be announced to the screenreader.
68+
* Announces a message to screen readers.
69+
* @param message Message to be announced to the screen reader.
7070
* @param duration Time in milliseconds after which to clear out the announcer element. Note
7171
* that this takes effect after the message has been added to the DOM, which can be up to
7272
* 100ms after `announce` has been called.
@@ -75,8 +75,8 @@ export class LiveAnnouncer implements OnDestroy {
7575
announce(message: string, duration?: number): Promise<void>;
7676

7777
/**
78-
* Announces a message to screenreaders.
79-
* @param message Message to be announced to the screenreader.
78+
* Announces a message to screen readers.
79+
* @param message Message to be announced to the screen reader.
8080
* @param politeness The politeness of the announcer element.
8181
* @param duration Time in milliseconds after which to clear out the announcer element. Note
8282
* that this takes effect after the message has been added to the DOM, which can be up to

src/cdk/bidi/dir-document-token.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import {inject, InjectionToken} from '@angular/core';
1616
* We can't use the real document in tests because changing the real `dir` causes geometry-based
1717
* tests in Safari to fail.
1818
*
19-
* We also can't re-provide the DOCUMENT token from platform-brower because the unit tests
19+
* We also can't re-provide the DOCUMENT token from platform-browser because the unit tests
2020
* themselves use things like `querySelector` in test code.
2121
*
2222
* This token is defined in a separate file from Directionality as a workaround for

src/cdk/clipboard/pending-copy.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
* A pending copy-to-clipboard operation.
1111
*
1212
* The implementation of copying text to the clipboard modifies the DOM and
13-
* forces a relayout. This relayout can take too long if the string is large,
13+
* forces a re-layout. This re-layout can take too long if the string is large,
1414
* causing the execCommand('copy') to happen too long after the user clicked.
1515
* This results in the browser refusing to copy. This object lets the
16-
* relayout happen in a separate tick from copying by providing a copy function
16+
* re-layout happen in a separate tick from copying by providing a copy function
1717
* that can be called later.
1818
*
1919
* Destroy must be called when no longer in use, regardless of whether `copy` is

src/cdk/drag-drop/directives/drag.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ export class CdkDrag<T = any> implements AfterViewInit, OnChanges, OnDestroy {
132132
/**
133133
* Function that can be used to customize the logic of how the position of the drag item
134134
* is limited while it's being dragged. Gets called with a point containing the current position
135-
* of the user's pointer on the page, a reference to the item being dragged and its dimenstions.
135+
* of the user's pointer on the page, a reference to the item being dragged and its dimensions.
136136
* Should return a point describing where the item should be rendered.
137137
*/
138138
@Input('cdkDragConstrainPosition') constrainPosition?: (

src/cdk/drag-drop/drag-drop-registry.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ export class DragDropRegistry<I extends {isDragging(): boolean}, C> implements O
207207
const streams: Observable<Event>[] = [this.scroll];
208208

209209
if (shadowRoot && shadowRoot !== this._document) {
210-
// Note that this is basically the same as `fromEvent` from rjxs, but we do it ourselves,
210+
// Note that this is basically the same as `fromEvent` from rxjs, but we do it ourselves,
211211
// because we want to guarantee that the event is bound outside of the `NgZone`. With
212212
// `fromEvent` it'll only happen if the subscription is outside the `NgZone`.
213213
streams.push(

src/cdk/drag-drop/drag-ref.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ export class DragRef<T = any> {
358358
/**
359359
* Function that can be used to customize the logic of how the position of the drag item
360360
* is limited while it's being dragged. Gets called with a point containing the current position
361-
* of the user's pointer on the page, a reference to the item being dragged and its dimenstions.
361+
* of the user's pointer on the page, a reference to the item being dragged and its dimensions.
362362
* Should return a point describing where the item should be rendered.
363363
*/
364364
constrainPosition?: (
@@ -662,7 +662,7 @@ export class DragRef<T = any> {
662662
const isOverThreshold = distanceX + distanceY >= this._config.dragStartThreshold;
663663

664664
// Only start dragging after the user has moved more than the minimum distance in either
665-
// direction. Note that this is preferrable over doing something like `skip(minimumDistance)`
665+
// direction. Note that this is preferable over doing something like `skip(minimumDistance)`
666666
// in the `pointerMove` subscription, because we're not guaranteed to have one move event
667667
// per pixel of movement (e.g. if the user moves their pointer quickly).
668668
if (isOverThreshold) {

src/cdk/drag-drop/sorting/single-axis-sort-strategy.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ export class SingleAxisSortStrategy<T extends DropListSortStrategyItem>
6868

6969
/**
7070
* Keeps track of the item that was last swapped with the dragged item, as well as what direction
71-
* the pointer was moving in when the swap occured and whether the user's pointer continued to
71+
* the pointer was moving in when the swap occurred and whether the user's pointer continued to
7272
* overlap with the swapped item after the swapping occurred.
7373
*/
7474
private _previousSwap = {

src/cdk/menu/menu-item-radio.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export class CdkMenuItemRadio extends CdkMenuItemSelectable implements OnDestroy
3535
/** The unique selection dispatcher for this radio's `CdkMenuGroup`. */
3636
private readonly _selectionDispatcher = inject(UniqueSelectionDispatcher);
3737

38-
/** An ID to identify this radio item to the `UniqueSelectionDisptcher`. */
38+
/** An ID to identify this radio item to the `UniqueSelectionDispatcher`. */
3939
private _id = `${nextId++}`;
4040

4141
/** Function to unregister the selection dispatcher */

src/cdk/overlay/overlay-config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ export class OverlayConfig {
6969
if (config[key] !== undefined) {
7070
// TypeScript, as of version 3.5, sees the left-hand-side of this expression
7171
// as "I don't know *which* key this is, so the only valid value is the intersection
72-
// of all the posible values." In this case, that happens to be `undefined`. TypeScript
72+
// of all the possible values." In this case, that happens to be `undefined`. TypeScript
7373
// is not smart enough to see that the right-hand-side is actually an access of the same
7474
// exact type with the same exact key, meaning that the value type must be identical.
7575
// So we use `any` to work around this.

src/cdk/overlay/position/flexible-connected-position-strategy.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ export class FlexibleConnectedPositionStrategy implements PositionStrategy {
191191
* The selection of a position goes as follows:
192192
* - If any positions fit completely within the viewport as-is,
193193
* choose the first position that does so.
194-
* - If flexible dimensions are enabled and at least one satifies the given minimum width/height,
194+
* - If flexible dimensions are enabled and at least one satisfies the given minimum width/height,
195195
* choose the position with the greatest available size modified by the positions' weight.
196196
* - If pushing is enabled, take the position that went off-screen the least and push it
197197
* on-screen.
@@ -633,7 +633,7 @@ export class FlexibleConnectedPositionStrategy implements PositionStrategy {
633633

634634
/**
635635
* Gets the point at which the overlay can be "pushed" on-screen. If the overlay is larger than
636-
* the viewport, the top-left corner will be pushed on-screen (with overflow occuring on the
636+
* the viewport, the top-left corner will be pushed on-screen (with overflow occurring on the
637637
* right and bottom).
638638
*
639639
* @param start Starting point from which the overlay is pushed.
@@ -715,7 +715,7 @@ export class FlexibleConnectedPositionStrategy implements PositionStrategy {
715715

716716
// Notify that the position has been changed along with its change properties.
717717
// We only emit if we've got any subscriptions, because the scroll visibility
718-
// calculcations can be somewhat expensive.
718+
// calculations can be somewhat expensive.
719719
if (this._positionChanges.observers.length) {
720720
const scrollableViewProperties = this._getScrollVisibility();
721721
const changeEvent = new ConnectedOverlayPositionChange(position, scrollableViewProperties);
@@ -831,7 +831,7 @@ export class FlexibleConnectedPositionStrategy implements PositionStrategy {
831831

832832
/**
833833
* Sets the position and size of the overlay's sizing wrapper. The wrapper is positioned on the
834-
* origin's connection point and stetches to the bounds of the viewport.
834+
* origin's connection point and stretches to the bounds of the viewport.
835835
*
836836
* @param origin The point on the origin element where the overlay is connected.
837837
* @param position The position preference
@@ -1108,7 +1108,7 @@ export class FlexibleConnectedPositionStrategy implements PositionStrategy {
11081108
private _getOffset(position: ConnectedPosition, axis: 'x' | 'y') {
11091109
if (axis === 'x') {
11101110
// We don't do something like `position['offset' + axis]` in
1111-
// order to avoid breking minifiers that rename properties.
1111+
// order to avoid breaking minifiers that rename properties.
11121112
return position.offsetX == null ? this._offsetX : position.offsetX;
11131113
}
11141114

src/cdk/scrolling/scroll-dispatcher.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export class ScrollDispatcher implements OnDestroy {
6464
}
6565

6666
/**
67-
* Deregisters a Scrollable reference and unsubscribes from its scroll event observable.
67+
* De-registers a Scrollable reference and unsubscribes from its scroll event observable.
6868
* @param scrollable Scrollable instance to be deregistered.
6969
*/
7070
deregister(scrollable: CdkScrollable): void {

src/cdk/scrolling/scrolling.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ some cases where you want to have the viewport scroll one of its parent elements
135135
if you want to have some non-virtualized content that the user can scroll through before or after
136136
the virtualized content.
137137

138-
To configure a `cdk-vritual-scroll-viewport` to use one of its parent elements as the scrolling
138+
To configure a `cdk-virtual-scroll-viewport` to use one of its parent elements as the scrolling
139139
element, apply `cdkVirtualScrollingElement` to the scrolling parent element.
140140

141141
<!-- example(cdk-virtual-scroll-parent-scrolling) -->

src/cdk/stepper/stepper.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ export class CdkStepper implements AfterContentInit, AfterViewInit, OnDestroy {
330330
return this._orientation;
331331
}
332332
set orientation(value: StepperOrientation) {
333-
// This is a protected method so that `MatSteppter` can hook into it.
333+
// This is a protected method so that `MatStepper` can hook into it.
334334
this._orientation = value;
335335

336336
if (this._keyManager) {
@@ -362,7 +362,7 @@ export class CdkStepper implements AfterContentInit, AfterViewInit, OnDestroy {
362362
// rendered in the DOM which will lead to incorrect keyboard navigation. We need to sort
363363
// them manually to ensure that they're correct. Alternatively, we can change the Material
364364
// template to inline the headers in the `ngFor`, but that'll result in a lot of
365-
// code duplciation. See #23539.
365+
// code duplication. See #23539.
366366
this._stepHeader.changes
367367
.pipe(startWith(this._stepHeader), takeUntil(this._destroyed))
368368
.subscribe((headers: QueryList<CdkStepHeader>) => {

src/cdk/table/render-rows.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Rendering Data Rows
22

33
The table's primary responsibility is to render rows of cells. The types of rows that may be rendered are header,
4-
footer, and data rows. This document focuses on how the table tries to efficienctly render the data rows.
4+
footer, and data rows. This document focuses on how the table tries to efficiently render the data rows.
55

66
## Background
77

src/cdk/table/sticky-position-listener.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface StickyUpdate {
2222

2323
/**
2424
* If provided, CdkTable will call the methods below when it updates the size/
25-
* postion/etc of its sticky rows and columns.
25+
* position/etc of its sticky rows and columns.
2626
*/
2727
export interface StickyPositioningListener {
2828
/** Called when CdkTable updates its sticky start columns. */

src/cdk/table/table-errors.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
*/
88

99
/**
10-
* Returns an error to be thrown when attempting to find an unexisting column.
10+
* Returns an error to be thrown when attempting to find an nonexistent column.
1111
* @param id Id whose lookup failed.
1212
* @docs-private
1313
*/

src/cdk/table/table.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ abstract class RowViewRef<T> extends EmbeddedViewRef<RowContext<T>> {}
180180
* is false, there is only one template per data object). For each pair of data object and row
181181
* template, a `RenderRow` is added to the list of rows to render. If the data object and row
182182
* template pair has already been rendered, the previously used `RenderRow` is added; else a new
183-
* `RenderRow` is * created. Once the list is complete and all data objects have been itereated
183+
* `RenderRow` is * created. Once the list is complete and all data objects have been iterated
184184
* through, a diff is performed to determine the changes that need to be made to the rendered rows.
185185
*
186186
* @docs-private
@@ -349,13 +349,13 @@ export class CdkTable<T> implements AfterContentChecked, CollectionViewer, OnDes
349349
private _stickyStyler: StickyStyler;
350350

351351
/**
352-
* CSS class added to any row or cell that has sticky positioning applied. May be overriden by
352+
* CSS class added to any row or cell that has sticky positioning applied. May be overridden by
353353
* table subclasses.
354354
*/
355355
protected stickyCssClass: string = 'cdk-table-sticky';
356356

357357
/**
358-
* Whether to manually add positon: sticky to all sticky cell elements. Not needed if
358+
* Whether to manually add position: sticky to all sticky cell elements. Not needed if
359359
* the position is set in a selector associated with the value of stickyCssClass. May be
360360
* overridden by table subclasses
361361
*/

src/cdk/testing/test-harnesses.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ interface MyMenuItemHarnessFilters extends BaseHarnessFilters {
439439
class MyMenuHarness extends ComponentHarness {
440440
static hostSelector = 'my-menu';
441441

442-
/** Creates a `HarnessPredicate` used to locatr a particular `MyMenuHarness`. */
442+
/** Creates a `HarnessPredicate` used to locate a particular `MyMenuHarness`. */
443443
static with(options: MyMenuHarnessFilters): HarnessPredicate<MyMenuHarness> {
444444
return new HarnessPredicate(MyMenuHarness, options)
445445
.addOption('trigger text', options.triggerText,
@@ -460,7 +460,7 @@ class MyMenuHarness extends ComponentHarness {
460460
class MyMenuItemHarness extends ComponentHarness {
461461
static hostSelector = 'my-menu-item';
462462

463-
/** Creates a `HarnessPredicate` used to locatr a particular `MyMenuItemHarness`. */
463+
/** Creates a `HarnessPredicate` used to locate a particular `MyMenuItemHarness`. */
464464
static with(options: MyMenuItemHarnessFilters): HarnessPredicate<MyMenuItemHarness> {
465465
return new HarnessPredicate(MyMenuItemHarness, options)
466466
.addOption('text', options.text,

src/components-examples/cdk/drag-drop/cdk-drag-drop-custom-placeholder/cdk-drag-drop-custom-placeholder-example.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export class CdkDragDropCustomPlaceholderExample {
1919
'Episode VI - Return of the Jedi',
2020
'Episode VII - The Force Awakens',
2121
'Episode VIII - The Last Jedi',
22-
'Episode IX The Rise of Skywalker',
22+
'Episode IX - The Rise of Skywalker',
2323
];
2424

2525
drop(event: CdkDragDrop<string[]>) {

src/components-examples/cdk/tree/cdk-tree-nested/cdk-tree-nested-example.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import {NestedTreeControl} from '@angular/cdk/tree';
44

55
/**
66
* Food data with nested structure.
7-
* Each node has a name and an optiona list of children.
7+
* Each node has a name and an optional list of children.
88
*/
99
interface FoodNode {
1010
name: string;

src/dev-app/cdk-dialog/dialog-demo.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,14 @@ export class DialogDemo {
9696
standalone: true,
9797
})
9898
export class JazzDialog {
99-
private _dimesionToggle = false;
99+
private _dimensionToggle = false;
100100

101101
constructor(public dialogRef: DialogRef<string>, @Inject(DIALOG_DATA) public data: any) {}
102102

103103
togglePosition(): void {
104-
this._dimesionToggle = !this._dimesionToggle;
104+
this._dimensionToggle = !this._dimensionToggle;
105105

106-
if (this._dimesionToggle) {
106+
if (this._dimensionToggle) {
107107
this.dialogRef.updateSize('500px', '500px');
108108
} else {
109109
this.dialogRef.updateSize().updatePosition();

0 commit comments

Comments
 (0)