Skip to content

0.3.1 to 1.0.0 Migration Guide

mnewcomb314 edited this page Mar 1, 2021 · 17 revisions

Work In Progress

Introduction

The 1.0.0 release of CAM finished adding support for all ARIA roles. It also brought in some bug fixes and improvements, some of which are breaking changes that lead to multiple 1.0 pre-release versions of CAM before the 1.0.0 version was released. These breaking changes can be broken into the following categories and the below documentation describe code changes that consuming projects need to make in order to use the 1.0.0 version of CAM.

Role Splitting

  • ROLES.OPTION has been split into ROLES.SINGLESELECTOPTION and ROLES.MULTISELECTOPTION. This was needed in order to support getting ROLES.SINGLESELECTLISTBOX working visually consistent across browsers combined with CAM's one-to-one role to HTML tag mapping.
    • If an option is being added to a ROLES.SINGLESELECTLISTBOX, then replace ROLES.OPTION with ROLES.SINGLESELECTOPTION.
    • For options added to ROLES.MULTISELECTLISTBOX, then replace ROLES.OPTION with ROLES.MULTISELECTOPTION.

Parameter type fixes

  • the hasPopUp getter/setter of AccessibilityObject (the base class used to populate a registered DisplayObject's .accessible field) has been updated from a boolean to a string in order to allow for all the valid values that https://www.w3.org/TR/wai-aria-1.1/#aria-haspopup specifies
    • For existing true or false parameter values, add quotes around the value or use another mechanism to convert it to a string
    • For existing undefined parameter values, no change needs to be made

Clone this wiki locally