mirror of
https://github.com/google/blockly.git
synced 2025-12-16 14:20:10 +01:00
## The basics - [x] I [validated my changes](https://developers.google.com/blockly/guides/contribute/core#making_and_verifying_a_change) ## The details ### Resolves Fixes #8206 Fixes #8210 Fixes #8213 Fixes #8255 Fixes #8211 Fixes #8212 Fixes #8254 Fixes part of #9301 Fixes part of #9304 ### Proposed Changes This PR completes the remaining ARIA roles and properties needed for all core fields. Specifically: - #8206: A better name needed to be used for the checkbox value, plus there was an ARIA property missing for actually representing the checkbox state. The latter needed to be updated upon toggling the checkbox, as well. These changes bring checkbox fields in compliance with the ARIA checkbox pattern documented here: https://www.w3.org/WAI/ARIA/apg/patterns/checkbox/. - #8210: This one required a lot of changes in order to adapt to the ARIA combobox pattern documented here: https://www.w3.org/WAI/ARIA/apg/patterns/combobox/. Specifically: - Menus needed to have a unique ID that's also exposed in order to link the combobox element to its menu when open. - ARIA's `activedescendant` proved very useful in ensuring that the current dropdown selection is correctly read when the combobox has focus but its menu isn't opened. - The default properties available for options (label and value) aren't very good for readout, so a custom ARIA property was added for much clearer option readouts. This is only demonstrated for the math arithmetic block for now. - The text element is normally hidden for ARIA but it's useful in conjunction with `activedescendant` to represent the current value selection. - Images have been handled here as well (partly as part of #8255) by leveraging their alt text for readouts. This actually seems to work quite well both for current value and selection. - #8213: Much of the improvements here come from the combobox (`FieldDropdown`) improvements explained above. However one additional bit was done to provide an explicit 'Variable <name>' readout for the purpose of clarity. This demonstrates some contextualization of the value of the field which may be a generally useful pattern to copy in other field contexts. - #8255: Image fields have been refined since they were redundantly specifying 'image' when an `image` ARIA role is already being used. Now only the alt text is supplied along with the role context. Note that images need special handling since they can sometimes be navigable (such as when they have click handlers). - #8211: Text input fields have had their labeling improved like all other fields, and the field's value is now exposed via its `text` element since this will show up as a `StaticText` node in the accessibility tree and automatically be read as part of the field's value. - #8212: This gets the same benefits as the previous point since those improvements were included for both text and number input. However, existing `valuemin` and `valuemax` ARIA properties have been removed. It seems these are really only useful when introducing a slider mechanism (see https://www.w3.org/WAI/ARIA/apg/patterns/slider/) and from testing seems to not really be utilized for the basic text input that `FieldNumber` currently uses. It may be the case that this is a better pattern to use in the future, but it's more likely that other custom fields could benefit from more specific patterns like slider rather than `FieldNumber` being changed in that way. - #8254 and part of #9304: Field labels have been completely removed from the accessibility node tree since they can never be navigated to (as #8254 explains all labels will be included as part of the block's ARIA label itself for readout parity with navigation options). Note that it doesn't cover external fields (such as those supplied in blockly-samples), nor does it fully set up the infrastructure work for those. Ultimately that work needs to happen as part of #9301. Beyond the role work above, this PR also introduces some fundamental work for #9301. Specifically: - It demonstrates how block definitions could be used to introduce accessibility label customizations (in this case for the options of the arithmetic operator block's drop-down field, plus the block itself). - It sets up some central label computation for all fields, though more thought is needed on whether this is sufficient for custom fields outside of core Blockly and on how to properly contextualize labels for field values. Core Blockly's fields are fairly simple for representing values which is why that aspect of #9301 didn't need to be solved in this PR. Note that the field labeling here is being used to improve all of the fields above, but also it tries to aggressively fall back to the _next best_ label to be used (though it's possible to run out of options which is why fields still need contextually-specific fallbacks). ### Reason for Changes Generally the initial approach for implementing labels is leveraging as specific ARIA roles as exist to directly represent the element. This PR is completing that work for all of core Blockly's built-in fields, and laying some of the groundwork for generalizing this support for custom fields. Having specific roles does potentially introduce inconsistencies across screen readers (though should improve consistency across sites for a single screen reader), and expectations for behaviors (like shortcuts) that may need to be ignored or only partially supported (#9313 is discussing this). ### Test Coverage Only manual testing has been completed since this is experimental work. Video demonstrating most of the changes: [Screen recording 2025-10-01 4.05.35 PM.webm](https://github.com/user-attachments/assets/c7961caa-eae0-4585-8fd9-87d7cbe65988) ### Documentation N/A -- Experimental work. ### Additional Information This has only been tested on ChromeVox.
520 lines
10 KiB
TypeScript
520 lines
10 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2013 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
// Former goog.module ID: Blockly.Css
|
|
/** Has CSS already been injected? */
|
|
let injected = false;
|
|
|
|
/**
|
|
* Add some CSS to the blob that will be injected later. Allows optional
|
|
* components such as fields and the toolbox to store separate CSS.
|
|
*
|
|
* @param cssContent Multiline CSS string or an array of single lines of CSS.
|
|
*/
|
|
export function register(cssContent: string) {
|
|
if (injected) {
|
|
throw Error('CSS already injected');
|
|
}
|
|
content += '\n' + cssContent;
|
|
}
|
|
|
|
/**
|
|
* Inject the CSS into the DOM. This is preferable over using a regular CSS
|
|
* file since:
|
|
* a) It loads synchronously and doesn't force a redraw later.
|
|
* b) It speeds up loading by not blocking on a separate HTTP transfer.
|
|
* c) The CSS content may be made dynamic depending on init options.
|
|
*
|
|
* @param hasCss If false, don't inject CSS (providing CSS becomes the
|
|
* document's responsibility).
|
|
* @param pathToMedia Path from page to the Blockly media directory.
|
|
*/
|
|
export function inject(hasCss: boolean, pathToMedia: string) {
|
|
// Only inject the CSS once.
|
|
if (injected) {
|
|
return;
|
|
}
|
|
injected = true;
|
|
if (!hasCss) {
|
|
return;
|
|
}
|
|
// Strip off any trailing slash (either Unix or Windows).
|
|
const mediaPath = pathToMedia.replace(/[\\/]$/, '');
|
|
const cssContent = content.replace(/<<<PATH>>>/g, mediaPath);
|
|
// Cleanup the collected css content after injecting it to the DOM.
|
|
content = '';
|
|
|
|
// Inject CSS tag at start of head.
|
|
const cssNode = document.createElement('style');
|
|
cssNode.id = 'blockly-common-style';
|
|
const cssTextNode = document.createTextNode(cssContent);
|
|
cssNode.appendChild(cssTextNode);
|
|
document.head.insertBefore(cssNode, document.head.firstChild);
|
|
}
|
|
|
|
/**
|
|
* The CSS content for Blockly.
|
|
*/
|
|
let content = `
|
|
.blocklySvg {
|
|
background-color: #fff;
|
|
outline: none;
|
|
overflow: hidden; /* IE overflows by default. */
|
|
position: absolute;
|
|
display: block;
|
|
}
|
|
|
|
.blocklyWidgetDiv {
|
|
display: none;
|
|
position: absolute;
|
|
z-index: 99999; /* big value for bootstrap3 compatibility */
|
|
}
|
|
|
|
.injectionDiv {
|
|
height: 100%;
|
|
position: relative;
|
|
overflow: hidden; /* So blocks in drag surface disappear at edges */
|
|
touch-action: none;
|
|
user-select: none;
|
|
-webkit-user-select: none;
|
|
}
|
|
|
|
.blocklyBlockCanvas.blocklyCanvasTransitioning,
|
|
.blocklyBubbleCanvas.blocklyCanvasTransitioning {
|
|
transition: transform .5s;
|
|
}
|
|
|
|
.blocklyEmboss {
|
|
filter: var(--blocklyEmbossFilter);
|
|
}
|
|
|
|
.blocklyTooltipDiv {
|
|
background-color: #ffffc7;
|
|
border: 1px solid #ddc;
|
|
box-shadow: 4px 4px 20px 1px rgba(0,0,0,.15);
|
|
color: #000;
|
|
display: none;
|
|
font: 9pt sans-serif;
|
|
opacity: .9;
|
|
padding: 2px;
|
|
position: absolute;
|
|
z-index: 100000; /* big value for bootstrap3 compatibility */
|
|
}
|
|
|
|
.blocklyDropDownDiv {
|
|
position: absolute;
|
|
left: 0;
|
|
top: 0;
|
|
z-index: 1000;
|
|
display: none;
|
|
border: 1px solid;
|
|
border-color: #dadce0;
|
|
background-color: #fff;
|
|
border-radius: 2px;
|
|
padding: 4px;
|
|
box-shadow: 0 0 3px 1px rgba(0,0,0,.3);
|
|
}
|
|
|
|
.blocklyDropDownDiv:focus {
|
|
box-shadow: 0 0 6px 1px rgba(0,0,0,.3);
|
|
}
|
|
|
|
.blocklyDropDownContent {
|
|
max-height: 300px; /* @todo: spec for maximum height. */
|
|
}
|
|
|
|
.blocklyDropDownArrow {
|
|
position: absolute;
|
|
left: 0;
|
|
top: 0;
|
|
width: 16px;
|
|
height: 16px;
|
|
z-index: -1;
|
|
background-color: inherit;
|
|
border-color: inherit;
|
|
border-top: 1px solid;
|
|
border-left: 1px solid;
|
|
border-top-left-radius: 4px;
|
|
border-color: inherit;
|
|
}
|
|
|
|
.blocklyHighlighted>.blocklyPath {
|
|
filter: var(--blocklyEmbossFilter);
|
|
}
|
|
|
|
.blocklyHighlightedConnectionPath {
|
|
fill: none;
|
|
stroke: #fc3;
|
|
stroke-width: 4px;
|
|
}
|
|
|
|
.blocklyPathLight {
|
|
fill: none;
|
|
stroke-linecap: round;
|
|
stroke-width: 1;
|
|
}
|
|
|
|
.blocklySelected>.blocklyPathLight {
|
|
display: none;
|
|
}
|
|
|
|
.blocklyDraggable {
|
|
cursor: grab;
|
|
cursor: -webkit-grab;
|
|
}
|
|
|
|
.blocklyDragging {
|
|
cursor: grabbing;
|
|
cursor: -webkit-grabbing;
|
|
/* Drag surface disables events to not block the toolbox, so we have to
|
|
* reenable them here for the cursor values to work. */
|
|
pointer-events: auto;
|
|
}
|
|
|
|
/* Changes cursor on mouse down. Not effective in Firefox because of
|
|
https://bugzilla.mozilla.org/show_bug.cgi?id=771241 */
|
|
.blocklyDraggable:active {
|
|
cursor: grabbing;
|
|
cursor: -webkit-grabbing;
|
|
}
|
|
|
|
.blocklyDragging.blocklyDraggingDelete,
|
|
.blocklyDragging.blocklyDraggingDelete .blocklyField {
|
|
cursor: url("<<<PATH>>>/handdelete.cur"), auto;
|
|
}
|
|
|
|
.blocklyDragging>.blocklyPath,
|
|
.blocklyDragging>.blocklyPathLight {
|
|
fill-opacity: .8;
|
|
stroke-opacity: .8;
|
|
}
|
|
|
|
.blocklyDragging>.blocklyPathDark {
|
|
display: none;
|
|
}
|
|
|
|
.blocklyDisabledPattern>.blocklyPath {
|
|
fill: var(--blocklyDisabledPattern);
|
|
fill-opacity: .5;
|
|
stroke-opacity: .5;
|
|
}
|
|
|
|
.blocklyDisabled>.blocklyPathLight,
|
|
.blocklyDisabled>.blocklyPathDark {
|
|
display: none;
|
|
}
|
|
|
|
.blocklyInsertionMarker>.blocklyPath,
|
|
.blocklyInsertionMarker>.blocklyPathLight,
|
|
.blocklyInsertionMarker>.blocklyPathDark {
|
|
fill-opacity: .2;
|
|
stroke: none;
|
|
}
|
|
|
|
.blocklyNonEditableField>text {
|
|
pointer-events: none;
|
|
}
|
|
|
|
.blocklyFlyout {
|
|
position: absolute;
|
|
z-index: 20;
|
|
}
|
|
|
|
.blocklyText text {
|
|
cursor: default;
|
|
}
|
|
|
|
/*
|
|
Don't allow users to select text. It gets annoying when trying to
|
|
drag a block and selected text moves instead.
|
|
*/
|
|
.blocklySvg text {
|
|
user-select: none;
|
|
-ms-user-select: none;
|
|
-webkit-user-select: none;
|
|
cursor: inherit;
|
|
}
|
|
|
|
.blocklyIconGroup {
|
|
cursor: default;
|
|
}
|
|
|
|
.blocklyIconGroup:not(:hover):not(:focus),
|
|
.blocklyIconGroupReadonly {
|
|
opacity: .6;
|
|
}
|
|
|
|
.blocklyIconShape {
|
|
fill: #00f;
|
|
stroke: #fff;
|
|
stroke-width: 1px;
|
|
}
|
|
|
|
.blocklyIconSymbol {
|
|
fill: #fff;
|
|
}
|
|
|
|
.blocklyMinimalBody {
|
|
margin: 0;
|
|
padding: 0;
|
|
height: 100%;
|
|
}
|
|
|
|
.blocklyHtmlInput {
|
|
border: none;
|
|
border-radius: 4px;
|
|
height: 100%;
|
|
margin: 0;
|
|
outline: none;
|
|
padding: 0;
|
|
width: 100%;
|
|
text-align: center;
|
|
display: block;
|
|
box-sizing: border-box;
|
|
}
|
|
|
|
/* Remove the increase and decrease arrows on the field number editor */
|
|
input.blocklyHtmlInput[type=number]::-webkit-inner-spin-button,
|
|
input.blocklyHtmlInput[type=number]::-webkit-outer-spin-button {
|
|
-webkit-appearance: none;
|
|
margin: 0;
|
|
}
|
|
|
|
input[type=number] {
|
|
-moz-appearance: textfield;
|
|
}
|
|
|
|
.blocklyMainBackground {
|
|
stroke-width: 1;
|
|
stroke: #c6c6c6; /* Equates to #ddd due to border being off-pixel. */
|
|
}
|
|
|
|
.blocklyMutatorBackground {
|
|
fill: #fff;
|
|
stroke: #ddd;
|
|
stroke-width: 1;
|
|
}
|
|
|
|
.blocklyFlyoutBackground {
|
|
fill: #ddd;
|
|
fill-opacity: .8;
|
|
}
|
|
|
|
.blocklyMainWorkspaceScrollbar {
|
|
z-index: 20;
|
|
}
|
|
|
|
.blocklyFlyoutScrollbar {
|
|
z-index: 30;
|
|
}
|
|
|
|
.blocklyScrollbarHorizontal,
|
|
.blocklyScrollbarVertical {
|
|
position: absolute;
|
|
outline: none;
|
|
}
|
|
|
|
.blocklyScrollbarBackground {
|
|
opacity: 0;
|
|
pointer-events: none;
|
|
}
|
|
|
|
.blocklyScrollbarHandle {
|
|
fill: #ccc;
|
|
}
|
|
|
|
.blocklyScrollbarBackground:hover+.blocklyScrollbarHandle,
|
|
.blocklyScrollbarHandle:hover {
|
|
fill: #bbb;
|
|
}
|
|
|
|
/* Darken flyout scrollbars due to being on a grey background. */
|
|
/* By contrast, workspace scrollbars are on a white background. */
|
|
.blocklyFlyout .blocklyScrollbarHandle {
|
|
fill: #bbb;
|
|
}
|
|
|
|
.blocklyFlyout .blocklyScrollbarBackground:hover+.blocklyScrollbarHandle,
|
|
.blocklyFlyout .blocklyScrollbarHandle:hover {
|
|
fill: #aaa;
|
|
}
|
|
|
|
.blocklyInvalidInput {
|
|
background: #faa;
|
|
}
|
|
|
|
.blocklyVerticalMarker {
|
|
stroke-width: 3px;
|
|
fill: rgba(255,255,255,.5);
|
|
pointer-events: none;
|
|
}
|
|
|
|
.blocklyComputeCanvas {
|
|
position: absolute;
|
|
width: 0;
|
|
height: 0;
|
|
}
|
|
|
|
.blocklyNoPointerEvents {
|
|
pointer-events: none;
|
|
}
|
|
|
|
.blocklyContextMenu {
|
|
border-radius: 4px;
|
|
max-height: 100%;
|
|
}
|
|
|
|
.blocklyDropdownMenu {
|
|
border-radius: 2px;
|
|
padding: 0 !important;
|
|
}
|
|
|
|
.blocklyDropdownMenu .blocklyMenuItem {
|
|
/* 28px on the left for icon or checkbox. */
|
|
padding-left: 28px;
|
|
}
|
|
|
|
/* BiDi override for the resting state. */
|
|
.blocklyDropdownMenu .blocklyMenuItemRtl {
|
|
/* Flip left/right padding for BiDi. */
|
|
padding-left: 5px;
|
|
padding-right: 28px;
|
|
}
|
|
|
|
.blocklyWidgetDiv .blocklyMenu {
|
|
user-select: none;
|
|
-ms-user-select: none;
|
|
-webkit-user-select: none;
|
|
background: #fff;
|
|
border: 1px solid transparent;
|
|
box-shadow: 0 0 3px 1px rgba(0,0,0,.3);
|
|
font: normal 13px Arial, sans-serif;
|
|
margin: 0;
|
|
outline: none;
|
|
padding: 4px 0;
|
|
position: absolute;
|
|
overflow-y: auto;
|
|
overflow-x: hidden;
|
|
max-height: 100%;
|
|
z-index: 20000; /* Arbitrary, but some apps depend on it... */
|
|
}
|
|
|
|
.blocklyWidgetDiv .blocklyMenu:focus {
|
|
box-shadow: 0 0 6px 1px rgba(0,0,0,.3);
|
|
}
|
|
|
|
.blocklyDropDownDiv .blocklyMenu {
|
|
user-select: none;
|
|
-ms-user-select: none;
|
|
-webkit-user-select: none;
|
|
background: inherit; /* Compatibility with gapi, reset from goog-menu */
|
|
border: inherit; /* Compatibility with gapi, reset from goog-menu */
|
|
font: normal 13px "Helvetica Neue", Helvetica, sans-serif;
|
|
outline: none;
|
|
overflow-y: auto;
|
|
overflow-x: hidden;
|
|
max-height: 100%;
|
|
z-index: 20000; /* Arbitrary, but some apps depend on it... */
|
|
}
|
|
|
|
/* State: resting. */
|
|
.blocklyMenuItem {
|
|
border: none;
|
|
color: #000;
|
|
cursor: pointer;
|
|
list-style: none;
|
|
margin: 0;
|
|
/* 7em on the right for shortcut. */
|
|
min-width: 7em;
|
|
padding: 6px 15px;
|
|
white-space: nowrap;
|
|
}
|
|
|
|
/* State: disabled. */
|
|
.blocklyMenuItemDisabled {
|
|
color: #ccc;
|
|
cursor: inherit;
|
|
}
|
|
|
|
/* State: hover. */
|
|
.blocklyMenuItemHighlight {
|
|
background-color: rgba(0,0,0,.1);
|
|
}
|
|
|
|
/* State: selected/checked. */
|
|
.blocklyMenuItemCheckbox {
|
|
height: 16px;
|
|
position: absolute;
|
|
width: 16px;
|
|
}
|
|
|
|
.blocklyMenuItemSelected .blocklyMenuItemCheckbox {
|
|
background: url(<<<PATH>>>/sprites.png) no-repeat -48px -16px;
|
|
float: left;
|
|
margin-left: -24px;
|
|
position: static; /* Scroll with the menu. */
|
|
}
|
|
|
|
.blocklyMenuItemRtl .blocklyMenuItemCheckbox {
|
|
float: right;
|
|
margin-right: -24px;
|
|
}
|
|
|
|
.blocklyMenuSeparator {
|
|
background-color: #ccc;
|
|
height: 1px;
|
|
border: 0;
|
|
margin-left: 4px;
|
|
margin-right: 4px;
|
|
}
|
|
|
|
.blocklyBlockDragSurface, .blocklyAnimationLayer {
|
|
position: absolute;
|
|
top: 0;
|
|
left: 0;
|
|
right: 0;
|
|
bottom: 0;
|
|
overflow: visible !important;
|
|
z-index: 80;
|
|
pointer-events: none;
|
|
}
|
|
|
|
.blocklyField {
|
|
cursor: default;
|
|
}
|
|
|
|
.blocklyInputField {
|
|
cursor: text;
|
|
}
|
|
|
|
.blocklyDragging .blocklyField,
|
|
.blocklyDragging .blocklyIconGroup {
|
|
cursor: grabbing;
|
|
}
|
|
|
|
.blocklyActiveFocus:is(
|
|
.blocklyFlyout,
|
|
.blocklyWorkspace,
|
|
.blocklyField,
|
|
.blocklyPath,
|
|
.blocklyHighlightedConnectionPath,
|
|
.blocklyComment,
|
|
.blocklyBubble,
|
|
.blocklyIconGroup,
|
|
.blocklyTextarea
|
|
) {
|
|
outline: none;
|
|
}
|
|
|
|
.hiddenForAria {
|
|
position: absolute;
|
|
left: -9999px;
|
|
width: 1px;
|
|
height: px;
|
|
overflow: hidden;
|
|
}
|
|
`;
|