puppeteer/assets/js/0cef9437.72e2516d.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[4856],{3905:(t,e,n)=>{n.d(e,{Zo:()=>u,kt:()=>g});var a=n(67294);function l(t,e,n){return e in t?Object.defineProperty(t,e,{value:n,enumerable:!0,configurable:!0,writable:!0}):t[e]=n,t}function r(t,e){var n=Object.keys(t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(t);e&&(a=a.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),n.push.apply(n,a)}return n}function i(t){for(var e=1;e<arguments.length;e++){var n=null!=arguments[e]?arguments[e]:{};e%2?r(Object(n),!0).forEach((function(e){l(t,e,n[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(n)):r(Object(n)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(n,e))}))}return t}function p(t,e){if(null==t)return{};var n,a,l=function(t,e){if(null==t)return{};var n,a,l={},r=Object.keys(t);for(a=0;a<r.length;a++)n=r[a],e.indexOf(n)>=0||(l[n]=t[n]);return l}(t,e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(t);for(a=0;a<r.length;a++)n=r[a],e.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(t,n)&&(l[n]=t[n])}return l}var o=a.createContext({}),d=function(t){var e=a.useContext(o),n=e;return t&&(n="function"==typeof t?t(e):i(i({},e),t)),n},u=function(t){var e=d(t.components);return a.createElement(o.Provider,{value:e},t.children)},m={inlineCode:"code",wrapper:function(t){var e=t.children;return a.createElement(a.Fragment,{},e)}},k=a.forwardRef((function(t,e){var n=t.components,l=t.mdxType,r=t.originalType,o=t.parentName,u=p(t,["components","mdxType","originalType","parentName"]),k=d(n),g=l,N=k["".concat(o,".").concat(g)]||k[g]||m[g]||r;return n?a.createElement(N,i(i({ref:e},u),{},{components:n})):a.createElement(N,i({ref:e},u))}));function g(t,e){var n=arguments,l=e&&e.mdxType;if("string"==typeof t||l){var r=n.length,i=new Array(r);i[0]=k;var p={};for(var o in e)hasOwnProperty.call(e,o)&&(p[o]=e[o]);p.originalType=t,p.mdxType="string"==typeof t?t:l,i[1]=p;for(var d=2;d<r;d++)i[d]=n[d];return a.createElement.apply(null,i)}return a.createElement.apply(null,n)}k.displayName="MDXCreateElement"},35876:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>d,contentTitle:()=>p,default:()=>k,frontMatter:()=>i,metadata:()=>o,toc:()=>u});n(67294);var a=n(3905);function l(){return l=Object.assign||function(t){for(var e=1;e<arguments.length;e++){var n=arguments[e];for(var a in n)Object.prototype.hasOwnProperty.call(n,a)&&(t[a]=n[a])}return t},l.apply(this,arguments)}function r(t,e){if(null==t)return{};var n,a,l=function(t,e){if(null==t)return{};var n,a,l={},r=Object.keys(t);for(a=0;a<r.length;a++)n=r[a],e.indexOf(n)>=0||(l[n]=t[n]);return l}(t,e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(t);for(a=0;a<r.length;a++)n=r[a],e.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(t,n)&&(l[n]=t[n])}return l}const i={sidebar_label:"SerializedAXNode"},p="SerializedAXNode interface",o={unversionedId:"api/puppeteer.serializedaxnode",id:"api/puppeteer.serializedaxnode",title:"SerializedAXNode interface",description:"Represents a Node and the properties of it that are relevant to Accessibility.",source:"@site/../docs/api/puppeteer.serializedaxnode.md",sourceDirName:"api",slug:"/api/puppeteer.serializedaxnode",permalink:"/next/api/puppeteer.serializedaxnode",draft:!1,tags:[],version:"current",frontMatter:{sidebar_label:"SerializedAXNode"},sidebar:"api",previous:{title:"ScreenshotOptions",permalink:"/next/api/puppeteer.screenshotoptions"},next:{title:"SnapshotOptions",permalink:"/next/api/puppeteer.snapshotoptions"}},d={},u=[{value:"Signature:",id:"signature",level:4},{value:"Properties",id:"properties",level:2}],m={toc:u};function k(t){var{components:e}=t,n=r(t,["components"]);return(0,a.kt)("wrapper",l({},m,n,{components:e,mdxType:"MDXLayout"}),(0,a.kt)("h1",l({},{id:"serializedaxnode-interface"}),"SerializedAXNode interface"),(0,a.kt)("p",null,"Represents a Node and the properties of it that are relevant to Accessibility."),(0,a.kt)("h4",l({},{id:"signature"}),"Signature:"),(0,a.kt)("pre",null,(0,a.kt)("code",l({parentName:"pre"},{className:"language-typescript"}),"export interface SerializedAXNode\n")),(0,a.kt)("h2",l({},{id:"properties"}),"Properties"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",l({parentName:"tr"},{align:null}),"Property"),(0,a.kt)("th",l({parentName:"tr"},{align:null}),"Modifiers"),(0,a.kt)("th",l({parentName:"tr"},{align:null}),"Type"),(0,a.kt)("th",l({parentName:"tr"},{align:null}),"Description"),(0,a.kt)("th",l({parentName:"tr"},{align:null}),"Default"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"autocomplete"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"string"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"checked"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"boolean ","|"," 'mixed'"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"Whether the checkbox is checked, or in a ",(0,a.kt)("a",l({parentName:"td"},{href:"https://www.w3.org/TR/wai-aria-practices/examples/checkbox/checkbox-2/checkbox-2.html"}),"mixed state"),"."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"children"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("a",l({parentName:"td"},{href:"/next/api/puppeteer.serializedaxnode"}),"SerializedAXNode"),"[","]"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"Children of this node, if there are any."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"description"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"string"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"An additional human readable description of the node."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"disabled"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"expanded"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"focused"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"haspopup"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"string"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"invalid"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"string"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"Whether and in what way this node's value is invalid."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"keyshortcuts"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"string"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"Any keyboard shortcuts associated with this node."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"level"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"number"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"The level of a heading."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"modal"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"multiline"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"multiselectable"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"Whether more than one child can be selected."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"name"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"string"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"A human readable name for the node."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"orientation"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"string"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"pressed"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"boolean ","|"," 'mixed'"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"Whether the node is checked or in a mixed state."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"readonly"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"required"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"role"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"string"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"The ",(0,a.kt)("a",l({parentName:"td"},{href:"https://www.w3.org/TR/wai-aria/#usage_intro"}),"role")," of the node."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"roledescription"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"string"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"A human readable alternative to the role."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"selected"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"boolean"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"value"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"string ","|"," number"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"The current value of the node."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"valuemax"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"number"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"valuemin"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"number"),(0,a.kt)("td",l({parentName:"tr"},{align:null})),(0,a.kt)("td",l({parentName:"tr"},{align:null}))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",l({parentName:"tr"},{align:null}),"valuetext"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),(0,a.kt)("code",null,"optional")),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"string"),(0,a.kt)("td",l({parentName:"tr"},{align:null}),"A description of the current value."),(0,a.kt)("td",l({parentName:"tr"},{align:null}))))))}k.isMDXComponent=!0}}]);