Merge pull request #468 from github/kendallgassner-patch-1

kendallgassner · web-flow · commit 2a6777e3e2bc · 2023-07-21T14:17:48.000-07:00
Update a11y-no-visually-hidden-interactive-element.md
diff --git a/docs/rules/a11y-no-visually-hidden-interactive-element.md b/docs/rules/a11y-no-visually-hidden-interactive-element.md
@@ -12,7 +12,7 @@ Note: we are not guarding against visually hidden `input` elements at this time.
 
 ### Why do we visually hide content?
 
-Visually hiding content can be useful when you want to provide information specifically to screen reader users or other assitive technology users while keeping content hidden from sighted users.
+Visually hiding content can be useful when you want to provide information specifically to screen reader users or other assistive technology users while keeping content hidden from sighted users.
 
 Applying the following css will visually hide content while still making it accessible to screen reader users.
 
@@ -61,16 +61,14 @@ width: 1px;
 
 - className - A css className that visually hides content. Defaults to `sr-only`.
 - componentName - A react component name that visually hides content. Defaults to `VisuallyHidden`.
-- htmlPropName - A prop name used to replace the semantic element that is rendered. Defaults to `as`.
 
 ```json
 {
   "a11y-no-visually-hidden-interactive-element": [
     "error",
     {
       "className": "visually-hidden",
-      "componentName": "VisuallyHidden",
-      "htmlPropName": "as"
+      "componentName": "VisuallyHidden"
     }
   ]
 }
diff --git a/lib/rules/a11y-no-visually-hidden-interactive-element.js b/lib/rules/a11y-no-visually-hidden-interactive-element.js
@@ -8,7 +8,6 @@ const defaultcomponentName = 'VisuallyHidden'
 const schema = generateObjSchema({
   className: {type: 'string'},
   componentName: {type: 'string'},
-  htmlPropName: {type: 'string'},
 })
 
 /** Note: we are not including input elements at this time

Original file line number	Diff line number	Diff line change
@@ -12,7 +12,7 @@ Note: we are not guarding against visually hidden `input` elements at this time.
`12`	`12`
`13`	`13`	`### Why do we visually hide content?`
`14`	`14`
`15`		`-Visually hiding content can be useful when you want to provide information specifically to screen reader users or other assitive technology users while keeping content hidden from sighted users.`
	`15`	`+Visually hiding content can be useful when you want to provide information specifically to screen reader users or other assistive technology users while keeping content hidden from sighted users.`
`16`	`16`
`17`	`17`	`Applying the following css will visually hide content while still making it accessible to screen reader users.`
`18`	`18`
`@@ -61,16 +61,14 @@ width: 1px;`
`61`	`61`
`62`	`62`	- className - A css className that visually hides content. Defaults to `sr-only`.
`63`	`63`	- componentName - A react component name that visually hides content. Defaults to `VisuallyHidden`.
`64`		-- htmlPropName - A prop name used to replace the semantic element that is rendered. Defaults to `as`.
`65`	`64`
`66`	`65`	```json
`67`	`66`	`{`
`68`	`67`	`"a11y-no-visually-hidden-interactive-element": [`
`69`	`68`	`"error",`
`70`	`69`	`{`
`71`	`70`	`"className": "visually-hidden",`
`72`		`- "componentName": "VisuallyHidden",`
`73`		`- "htmlPropName": "as"`
	`71`	`+ "componentName": "VisuallyHidden"`
`74`	`72`	`}`
`75`	`73`	`]`
`76`	`74`	`}`