puppeteer/assets/js/0cef9437.27ddb755.js

/*! For license information please see 0cef9437.27ddb755.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[4856],{86567:(e,d,n)=>{n.r(d),n.d(d,{assets:()=>c,contentTitle:()=>t,default:()=>j,frontMatter:()=>r,metadata:()=>l,toc:()=>h});var s=n(85893),i=n(11151);const r={sidebar_label:"SerializedAXNode"},t="SerializedAXNode interface",l={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,unlisted:!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"}},c={},h=[{value:"Signature:",id:"signature",level:4},{value:"Properties",id:"properties",level:2}];function x(e){const d={a:"a",code:"code",h1:"h1",h2:"h2",h4:"h4",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(d.h1,{id:"serializedaxnode-interface",children:"SerializedAXNode interface"}),"\n",(0,s.jsx)(d.p,{children:"Represents a Node and the properties of it that are relevant to Accessibility."}),"\n",(0,s.jsx)(d.h4,{id:"signature",children:"Signature:"}),"\n",(0,s.jsx)(d.pre,{children:(0,s.jsx)(d.code,{className:"language-typescript",children:"export interface SerializedAXNode\n"})}),"\n",(0,s.jsx)(d.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsxs)("table",{children:[(0,s.jsx)("thead",{children:(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(d.p,{children:"Property"})}),(0,s.jsx)("th",{children:(0,s.jsx)(d.p,{children:"Modifiers"})}),(0,s.jsx)("th",{children:(0,s.jsx)(d.p,{children:"Type"})}),(0,s.jsx)("th",{children:(0,s.jsx)(d.p,{children:"Description"})}),(0,s.jsx)("th",{children:(0,s.jsx)(d.p,{children:"Default"})})]})}),(0,s.jsxs)("tbody",{children:[(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"autocomplete",children:"autocomplete"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"string"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"checked",children:"checked"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"boolean | 'mixed'"})}),(0,s.jsx)("td",{children:(0,s.jsxs)(d.p,{children:["Whether the checkbox is checked, or in a ",(0,s.jsx)(d.a,{href:"https://www.w3.org/TR/wai-aria-practices/examples/checkbox/checkbox-2/checkbox-2.html",children:"mixed state"}),"."]})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"children",children:"children"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsxs)(d.p,{children:[(0,s.jsx)(d.a,{href:"/next/api/puppeteer.serializedaxnode",children:"SerializedAXNode"}),"[]"]})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"Children of this node, if there are any."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"description",children:"description"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"string"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"An additional human readable description of the node."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"disabled",children:"disabled"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"boolean"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"expanded",children:"expanded"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"boolean"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"focused",children:"focused"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"boolean"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"haspopup",children:"haspopup"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"string"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"invalid",children:"invalid"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"string"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"Whether and in what way this node's value is invalid."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"keyshortcuts",children:"keyshortcuts"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"string"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"Any keyboard shortcuts associated with this node."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"level",children:"level"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"number"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"The level of a heading."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"modal",children:"modal"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"boolean"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"multiline",children:"multiline"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"boolean"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"multiselectable",children:"multiselectable"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"boolean"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"Whether more than one child can be selected."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"name",children:"name"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"string"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"A human readable name for the node."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"orientation",children:"orientation"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"string"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"pressed",children:"pressed"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"boolean | 'mixed'"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"Whether the node is checked or in a mixed state."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"readonly",children:"readonly"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"boolean"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"required",children:"required"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"boolean"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"role",children:"role"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"string"})}),(0,s.jsx)("td",{children:(0,s.jsxs)(d.p,{children:["The ",(0,s.jsx)(d.a,{href:"https://www.w3.org/TR/wai-aria/#usage_intro",children:"role"})," of the node."]})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"roledescription",children:"roledescription"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"string"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"A human readable alternative to the role."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"selected",children:"selected"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"boolean"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"value",children:"value"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"string | number"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"The current value of the node."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"valuemax",children:"valuemax"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"number"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"valuemin",children:"valuemin"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"number"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"valuetext",children:"valuetext"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:(0,s.jsx)(d.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"string"})}),(0,s.jsx)("td",{children:(0,s.jsx)(d.p,{children:"A description of the current value."})}),(0,s.jsx)("td",{})]})]})]})]})}function j(e={}){const{wrapper:d}={...(0,i.a)(),...e.components};return d?(0,s.jsx)(d,{...e,children:(0,s.jsx)(x,{...e})}):x(e)}},75251:(e,d,n)=>{var s=n(67294),i=Symbol.for("react.element"),r=Symbol.for("react.fragment"),t=Object.prototype.hasOwnProperty,l=s.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner,c={key:!0,ref:!0,__self:!0,__source:!0};function h(e,d,n){var s,r={},h=null,x=null;for(s in void 0!==n&&(h=""+n),void 0!==d.key&&(h=""+d.key),void 0!==d.ref&&(x=d.ref),d)t.call(d,s)&&!c.hasOwnProperty(s)&&(r[s]=d[s]);if(e&&e.defaultProps)for(s in d=e.defaultProps)void 0===r[s]&&(r[s]=d[s]);return{$$typeof:i,type:e,key:h,ref:x,props:r,_owner:l.current}}d.Fragment=r,d.jsx=h,d.jsxs=h},85893:(e,d,n)=>{e.exports=n(75251)},11151:(e,d,n)=>{n.d(d,{Z:()=>l,a:()=>t});var s=n(67294);const i={},r=s.createContext(i);function t(e){const d=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(d):{...d,...e}}),[d,e])}function l(e){let d;return d=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),s.createElement(r.Provider,{value:d},e.children)}}}]);