WRR-10797: Fixed typos and grammar errors (#1758)

* fixed unsafe urls, deprecated functions and incorrect JSDocs * fixed grammar errors * Fixed typos in sandstone code * Update samples/qa-a11y/src/components/Section.js Co-authored-by: Stanca <63341832+stanca-pop-lgp@users.noreply.github.com> * reverted removal of subtraction * reverted change of URLs * revert unsafe url * reverted jsdoc issues * reverted jsdoc issues * reverted deprecated functions --------- Co-authored-by: Stanca <63341832+stanca-pop-lgp@users.noreply.github.com>
enactjs · Dec 16, 2024 · 248ca04 · 248ca04
1 parent 6227c36
commit 248ca04
Show file tree

Hide file tree

Showing 84 changed files with 197 additions and 197 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -320,7 +320,7 @@ No significant changes.
 
 ### Fixed
 
-- `sandstone/Dropdown' to focus properly the first option and the last option via page up and page down
+- `sandstone/Dropdown` to focus properly the first option and the last option via page up and page down
 - `sandstone/QuickGuidePanels` to not lose focus when the last view is displayed
 
 ## [2.7.5] - 2023-08-04

diff --git a/Checkbox/Checkbox.js b/Checkbox/Checkbox.js
@@ -146,7 +146,7 @@ const CheckboxBase = kind({
 
 	computed: {
 		className: ({indeterminate, selected, standalone, styler}) => styler.append({selected, standalone, indeterminate}),
-		children: ({indeterminate, indeterminateIcon, children}) => (indeterminate ? indeterminateIcon : children) // This controls which icon to use, an not that icon's visual presence.
+		children: ({indeterminate, indeterminateIcon, children}) => (indeterminate ? indeterminateIcon : children) // This controls which icon to use, and not that icon's visual presence.
 	},
 
 	render: ({children, css, disabled, selected, ...rest}) => {

diff --git a/Checkbox/Checkbox.module.less b/Checkbox/Checkbox.module.less
@@ -128,7 +128,7 @@
 	line-height: 0;
 
 	.icon {
-		margin: 0;	// Needed to apply here insetad of on `.checkbox` due to .icon.size precedence :(
+		margin: 0;	// Needed to apply here instead of on `.checkbox` due to .icon.size precedence :(
 		border-radius: @sand-checkbox-border-radius;
 		position: relative;
 		text-align: center;

diff --git a/ContextualMenuDecorator/ContextualMenuDecorator.js b/ContextualMenuDecorator/ContextualMenuDecorator.js
@@ -62,7 +62,7 @@ const ScrollingRepeater = ({className, ...rest}) => (
 );
 
 const ContextualMenuDecoratorBase = hoc(defaultConfig, (config, Wrapped) => {
-	// we might not need Skinnable at all here. If we want to skin the popup and it's defined as a
+	// we might not need Skinnable at all here. If we want to skin the popup, and it's defined as a
 	// private component in this module, we can wrap it with skinnable and style it as needed there.
 	const Component = Skinnable(
 		ContextualPopupDecorator(

diff --git a/ContextualPopupDecorator/ContextualPopupDecorator.js b/ContextualPopupDecorator/ContextualPopupDecorator.js
@@ -313,7 +313,7 @@ const Decorator = hoc(defaultConfig, (config, Wrapped) => {
 				snapshot.shouldSpotActivator = (
 					// isn't set
 					!current ||
-					// is on the activator and we want to re-spot it so a11y read out can occur
+					// is on the activator, and we want to re-spot it so a11y read out can occur
 					current === prevState.activator ||
 					// is within the popup
 					this.containerNode.contains(current)
@@ -358,7 +358,7 @@ const Decorator = hoc(defaultConfig, (config, Wrapped) => {
 		}
 
 		generateId = () => {
-			return Math.random().toString(36).substr(2, 8);
+			return Math.random().toString(36).substring(2, 10);
 		};
 
 		getContainerNodeWidth () {

diff --git a/DayPicker/DayPicker.js b/DayPicker/DayPicker.js
@@ -54,7 +54,7 @@ const DayPickerBase = kind({
 		disabled: PropTypes.bool,
 
 		/**
-		 * Called when an day is selected or unselected.
+		 * Called when a day is selected or unselected.
 		 *
 		 * The event payload will be an object with the following members:
 		 * * `selected` - An array of numbers representing the selected days, 0 indexed where Sunday

diff --git a/DayPicker/DaySelectorDecorator.js b/DayPicker/DaySelectorDecorator.js
@@ -281,7 +281,7 @@ const DaySelectorDecorator = hoc((config, Wrapped) => {
 		locale: PropTypes.string,
 
 		/**
-		 * Called when an day is selected or unselected.
+		 * Called when a day is selected or unselected.
 		 *
 		 * The event payload will be an object with the following members:
 		 * * `selected` - An array of numbers representing the selected days, 0 indexed

diff --git a/DayPicker/tests/DayPicker-specs.js b/DayPicker/tests/DayPicker-specs.js
@@ -29,7 +29,7 @@ describe('DayPicker', () => {
 		// We need to change the locale to firstDayOfWeek !== 0.
 		// If firstDayOfWeek === 0, the number type check conditional statement
 		// is skipped due to the fast execution path of localizeSelected(), which
-		// reduces code coverage..
+		// reduces code coverage.
 		ilib.setLocale('es-ES');
 
 		render(<DayPicker locale="es-ES" selected={1} />);

diff --git a/FlexiblePopupPanels/FlexiblePopupPanels.module.less b/FlexiblePopupPanels/FlexiblePopupPanels.module.less
@@ -140,7 +140,7 @@
 		box-sizing: border-box;
 	}
 
-	&.auto { /* Availble for export */ }
+	&.auto { /* Available for export */ }
 
 	// These calculations are here (rather than the variables file) because they're
 	// implementation-specific rather than being generally useful due to the container

diff --git a/IconItem/IconItem.js b/IconItem/IconItem.js
@@ -96,7 +96,7 @@ const IconItemBase = kind({
 		bordered: PropTypes.bool,
 
 		/**
-		 * The custom component rendred as the content of this IconItem.
+		 * The custom component rendered as the content of this IconItem.
 		 *
 		 * @type {Component}
 		 * @public
@@ -152,7 +152,7 @@ const IconItemBase = kind({
 
 		/**
 		 * Source and size for the image.
-		 * See the datails in {@link sandstone/IconItem.ImageShape|ImageShape}
+		 * See the details in {@link sandstone/IconItem.ImageShape|ImageShape}
 		 *
 		 * @type {sandstone/IconItem.ImageShape}
 		 * @public

diff --git a/Input/InputField.js b/Input/InputField.js
@@ -26,7 +26,7 @@ import componentCss from './InputField.module.less';
 /**
  * A Sandstone styled input component.
  *
- * It supports start and end icons but it does not support Spotlight. Apps should use
+ * It supports start and end icons, but it does not support Spotlight. Apps should use
  * {@link sandstone/Input.InputField}.
  *
  * @class InputFieldBase

diff --git a/Input/Keypad.js b/Input/Keypad.js
@@ -95,7 +95,7 @@ const Keypad = kind({
 	}
 });
 
-// Setup a keypress handler for window that monitors each of the number keys and the backspace key
+// Set up a keypress handler for window that monitors each of the number keys and the backspace key
 const handleWindowKeyPress = handle(
 	oneOf(
 		[forKey('number'), forward('onAdd')],

diff --git a/MediaPlayer/MediaControls.js b/MediaPlayer/MediaControls.js
@@ -116,7 +116,7 @@ const MediaControlsBase = kind({
 		actionGuideLabel: PropTypes.string,
 
 		/**
-		 * These components are placed below the action guide. Typically these will be media playlist controls.
+		 * These components are placed below the action guide. Typically, these will be media playlist controls.
 		 *
 		 * @type {Node}
 		 * @public
@@ -446,7 +446,7 @@ const MediaControlsDecorator = hoc((config, Wrapped) => {
 			actionGuideLabel: PropTypes.string,
 
 			/**
-			 * These components are placed below the children. Typically these will be media playlist items.
+			 * These components are placed below the children. Typically, these will be media playlist items.
 			 *
 			 * @type {Node}
 			 * @public
@@ -568,7 +568,7 @@ const MediaControlsDecorator = hoc((config, Wrapped) => {
 			playPauseButtonDisabled: PropTypes.bool,
 
 			/**
-			 * Disables the media playback-rate control via rewind and fast forward keys
+			 * Disables the media playback-rate control via rewind and fast-forward keys
 			 *
 			 * @type {Boolean}
 			 * @public

diff --git a/MediaPlayer/Times.js b/MediaPlayer/Times.js
@@ -22,7 +22,7 @@ const TimesBase = kind({
 		/**
 		 * An instance of a Duration Formatter from i18n.
 		 *
-		 * Must has a `format()` method that returns a string.
+		 * Must have a `format()` method that returns a string.
 		 *
 		 * @type {Object}
 		 * @required

diff --git a/PageViews/tests/PageViews-specs.js b/PageViews/tests/PageViews-specs.js
@@ -10,8 +10,8 @@ describe('PageViews Specs', () => {
 		() => {
 			render(
 				<PageViews index={0}>
-					<Page>I gots contents</Page>
-					<Page>I gots contents</Page>
+					<Page>I got contents</Page>
+					<Page>I got contents</Page>
 				</PageViews>
 			);
 
@@ -28,8 +28,8 @@ describe('PageViews Specs', () => {
 		() => {
 			render(
 				<PageViews pageIndicatorType="number" index={0}>
-					<Page>I gots contents</Page>
-					<Page>I gots contents</Page>
+					<Page>I got contents</Page>
+					<Page>I got contents</Page>
 				</PageViews>
 			);
 
@@ -46,8 +46,8 @@ describe('PageViews Specs', () => {
 		() => {
 			render(
 				<PageViews index={1}>
-					<Page>I gots contents</Page>
-					<Page>I gots contents</Page>
+					<Page>I got contents</Page>
+					<Page>I got contents</Page>
 				</PageViews>
 			);
 
@@ -64,8 +64,8 @@ describe('PageViews Specs', () => {
 		() => {
 			render(
 				<PageViews pageIndicatorType="number" index={1}>
-					<Page>I gots contents</Page>
-					<Page>I gots contents</Page>
+					<Page>I got contents</Page>
+					<Page>I got contents</Page>
 				</PageViews>
 			);
 
@@ -84,8 +84,8 @@ describe('PageViews Specs', () => {
 			let index = 0;
 			const {rerender} = render(
 				<PageViews index={index} onTransition={spy} noAnimation>
-					<Page>I gots contents</Page>
-					<Page>I gots contents2</Page>
+					<Page>I got contents</Page>
+					<Page>I got contents2</Page>
 				</PageViews>
 			);
 
@@ -94,8 +94,8 @@ describe('PageViews Specs', () => {
 
 			rerender(
 				<PageViews index={index} onTransition={spy} noAnimation>
-					<Page>I gots contents</Page>
-					<Page>I gots contents2</Page>
+					<Page>I got contents</Page>
+					<Page>I got contents2</Page>
 				</PageViews>
 			);
 
@@ -115,8 +115,8 @@ describe('PageViews Specs', () => {
 			let index = 0;
 			const {rerender} = render(
 				<PageViews index={index} onWillTransition={spy} noAnimation>
-					<Page>I gots contents</Page>
-					<Page>I gots contents2</Page>
+					<Page>I got contents</Page>
+					<Page>I got contents2</Page>
 				</PageViews>
 			);
 
@@ -125,8 +125,8 @@ describe('PageViews Specs', () => {
 
 			rerender(
 				<PageViews index={index} onWillTransition={spy} noAnimation>
-					<Page>I gots contents</Page>
-					<Page>I gots contents2</Page>
+					<Page>I got contents</Page>
+					<Page>I got contents2</Page>
 				</PageViews>
 			);
 

diff --git a/Picker/Picker.js b/Picker/Picker.js
@@ -270,7 +270,7 @@ const PickerBase = kind({
 
 		/**
 		 * Allows picker to continue from the start of the list after it reaches the end and
-		 * vice-versa.
+		 * vice versa.
 		 *
 		 * @type {Boolean}
 		 * @public

diff --git a/Popup/Popup.js b/Popup/Popup.js
@@ -311,7 +311,7 @@ class Popup extends Component {
 
 		/**
 		 * Indicates that the popup will not trigger `onClose` when the user presses the cancel/back (e.g. `ESC`) key or
-		 * taps outside of the popup.
+		 * taps outside the popup.
 		 *
 		 * @type {Boolean}
 		 * @default false
@@ -616,7 +616,7 @@ class Popup extends Component {
 
 		off('keydown', this.handleKeyDown);
 
-		// if there is no currently-spotted control or it is wrapped by the popup's container, we
+		// if there is no currently-spotted control, or it is wrapped by the popup's container, we
 		// know it's safe to change focus
 		if (!current || (containerNode && containerNode.contains(current))) {
 			// attempt to set focus to the activator, if available
@@ -647,7 +647,7 @@ class Popup extends Component {
 		if (!Spotlight.isPaused() && !Spotlight.focus(containerId)) {
 			const current = Spotlight.getCurrent();
 
-			// In cases where the container contains no spottable controls or we're in pointer-mode, focus
+			// In cases where the container contains no spottable controls, or we're in pointer-mode, focus
 			// cannot inherently set the active container or blur the active control, so we must do that
 			// here.
 			if (current) {

diff --git a/PopupTabLayout/PopupTabLayout.js b/PopupTabLayout/PopupTabLayout.js
@@ -28,7 +28,7 @@ import Popup from '../Popup';
 
 import componentCss from './PopupTabLayout.module.less';
 
-// List all of the props from PopupTabLayout that we want to move from this component's root onto PopupTabLayout.
+// List all the props from PopupTabLayout that we want to move from this component's root onto PopupTabLayout.
 const popupPropList = ['noAutoDismiss', 'onHide', 'onKeyDown', 'onShow', 'open',
 	'position', 'scrimType', 'spotlightId', 'spotlightRestrict', 'id', 'className',
 	'style', 'noAnimation', 'onClose'];
@@ -78,7 +78,7 @@ const PopupTabLayoutBase = kind({
 		/**
 		 * Specify dimensions for the layout areas.
 		 *
-		 * All 4 combinations must me supplied: each of the elements, tabs and content in both
+		 * All 4 combinations must be supplied: each of the elements, tabs and content in both
 		 * collapsed and expanded state.
 		 *
 		 * @type {{tabs: {collapsed: Number, normal: Number}, content: {expanded: number, normal: number}}}

diff --git a/QuickGuidePanels/QuickGuidePanels.js b/QuickGuidePanels/QuickGuidePanels.js
@@ -22,7 +22,7 @@ import Steps from '../Steps';
 import css from './QuickGuidePanels.module.less';
 
 /**
- * A QuickGuidePaenls that has steps with corresponding panels and panels have full screen size content.
+ * A QuickGuidePanels that has steps with corresponding panels and panels have full screen size content.
  *
  * @example
  * 	<QuickGuidePanels>