Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

chore(lint): share and tighten JSX accessibility rules (#42045)

yyhcb1a8963e398
diff --git a/lint.config.ts b/lint.config.ts
index 7a47e29a00d..27152cd6477 100644
--- a/lint.config.ts
+++ b/lint.config.ts
@@ -22,7 +22,23 @@ const tailwindCanonicalClassesOverride = {
},
} satisfies NonNullable<OxlintConfig['overrides']>[number]
-export const webJsxA11yRules = {
+// Oxlint's default handler lists omit pointer and touch activation.
+const jsxInteractionHandlers = [
+ 'onClick',
+ 'onDoubleClick',
+ 'onContextMenu',
+ 'onMouseDown',
+ 'onMouseUp',
+ 'onPointerDown',
+ 'onPointerUp',
+ 'onTouchStart',
+ 'onTouchEnd',
+ 'onKeyPress',
+ 'onKeyDown',
+ 'onKeyUp',
+]
+
+export const jsxA11yRules = {
'jsx-a11y/alt-text': 'error',
'jsx-a11y/anchor-ambiguous-text': 'off',
'jsx-a11y/anchor-has-content': 'error',
@@ -34,6 +50,8 @@ export const webJsxA11yRules = {
'jsx-a11y/aria-unsupported-elements': 'error',
'jsx-a11y/autocomplete-valid': 'error',
'jsx-a11y/click-events-have-key-events': 'error',
+ // The native rule cannot resolve names supplied by Base UI render composition.
+ 'jsx-a11y/control-has-associated-label': 'off',
'jsx-a11y/heading-has-content': 'error',
'jsx-a11y/html-has-lang': 'error',
'jsx-a11y/iframe-has-title': 'error',
@@ -44,10 +62,15 @@ export const webJsxA11yRules = {
tabbable: ['button', 'checkbox', 'link', 'searchbox', 'spinbutton', 'switch', 'textbox'],
},
],
- 'jsx-a11y/label-has-associated-control': 'error',
+ 'jsx-a11y/label-has-associated-control': [
+ 'error',
+ { controlComponents: ['Checkbox', 'Textarea'] },
+ ],
+ 'jsx-a11y/lang': 'error',
'jsx-a11y/media-has-caption': 'error',
'jsx-a11y/mouse-events-have-key-events': 'error',
'jsx-a11y/no-access-key': 'error',
+ 'jsx-a11y/no-aria-hidden-on-focusable': 'error',
'jsx-a11y/no-autofocus': 'error',
'jsx-a11y/no-distracting-elements': 'error',
'jsx-a11y/no-interactive-element-to-noninteractive-role': [
@@ -60,16 +83,7 @@ export const webJsxA11yRules = {
'jsx-a11y/no-noninteractive-element-interactions': [
'error',
{
- handlers: [
- 'onClick',
- 'onError',
- 'onLoad',
- 'onMouseDown',
- 'onMouseUp',
- 'onKeyPress',
- 'onKeyDown',
- 'onKeyUp',
- ],
+ handlers: [...jsxInteractionHandlers, 'onError', 'onLoad'],
alert: ['onKeyUp', 'onKeyDown', 'onKeyPress'],
body: ['onError', 'onLoad'],
dialog: ['onKeyUp', 'onKeyDown', 'onKeyPress'],
@@ -80,8 +94,9 @@ export const webJsxA11yRules = {
'jsx-a11y/no-noninteractive-element-to-interactive-role': [
'error',
{
- ul: ['listbox', 'menu', 'menubar', 'radiogroup', 'tablist', 'tree', 'treegrid'],
- ol: ['listbox', 'menu', 'menubar', 'radiogroup', 'tablist', 'tree', 'treegrid'],
+ // ARIA in HTML allows list widgets here, but not treegrid.
+ ul: ['listbox', 'menu', 'menubar', 'radiogroup', 'tablist', 'tree'],
+ ol: ['listbox', 'menu', 'menubar', 'radiogroup', 'tablist', 'tree'],
li: ['menuitem', 'menuitemradio', 'menuitemcheckbox', 'option', 'row', 'tab', 'treeitem'],
table: ['grid'],
td: ['gridcell'],
@@ -91,7 +106,6 @@ export const webJsxA11yRules = {
'jsx-a11y/no-noninteractive-tabindex': [
'error',
{
- tags: [],
roles: ['tabpanel'],
allowExpressionValues: true,
},
@@ -101,7 +115,7 @@ export const webJsxA11yRules = {
'error',
{
allowExpressionValues: true,
- handlers: ['onClick', 'onMouseDown', 'onMouseUp', 'onKeyPress', 'onKeyDown', 'onKeyUp'],
+ handlers: jsxInteractionHandlers,
},
],
'jsx-a11y/role-has-required-aria-props': 'error',
@@ -788,8 +802,8 @@ export const lintConfig = {
},
},
{
- files: ['web/**/*.tsx'],
- rules: webJsxA11yRules,
+ files: ['web/**/*.{jsx,tsx}', 'packages/dify-ui/**/*.{jsx,tsx}'],
+ rules: jsxA11yRules,
},
{
files: ['web/**/*.stories.{js,cjs,mjs,jsx,ts,tsx}', 'web/**/*.story.{js,cjs,mjs,jsx,ts,tsx}'],
@@ -1162,113 +1176,6 @@ export const lintConfig = {
'eslint-react/no-use-context': 'off',
},
},
- {
- files: ['packages/dify-ui/**/*.tsx'],
- rules: {
- 'jsx-a11y/alt-text': 'error',
- 'jsx-a11y/anchor-ambiguous-text': 'off',
- 'jsx-a11y/anchor-has-content': 'off',
- 'jsx-a11y/anchor-is-valid': 'error',
- 'jsx-a11y/aria-activedescendant-has-tabindex': 'error',
- 'jsx-a11y/aria-props': 'error',
- 'jsx-a11y/aria-proptypes': 'error',
- 'jsx-a11y/aria-role': 'error',
- 'jsx-a11y/aria-unsupported-elements': 'error',
- 'jsx-a11y/autocomplete-valid': 'error',
- 'jsx-a11y/click-events-have-key-events': 'error',
- 'jsx-a11y/control-has-associated-label': 'off',
- 'jsx-a11y/heading-has-content': 'error',
- 'jsx-a11y/html-has-lang': 'error',
- 'jsx-a11y/iframe-has-title': 'error',
- 'jsx-a11y/img-redundant-alt': 'error',
- 'jsx-a11y/interactive-supports-focus': [
- 'error',
- {
- tabbable: [
- 'button',
- 'checkbox',
- 'link',
- 'searchbox',
- 'spinbutton',
- 'switch',
- 'textbox',
- ],
- },
- ],
- 'jsx-a11y/label-has-associated-control': 'off',
- 'jsx-a11y/media-has-caption': 'error',
- 'jsx-a11y/mouse-events-have-key-events': 'error',
- 'jsx-a11y/no-access-key': 'error',
- 'jsx-a11y/no-autofocus': 'error',
- 'jsx-a11y/no-distracting-elements': 'error',
- 'jsx-a11y/no-interactive-element-to-noninteractive-role': [
- 'error',
- {
- tr: ['none', 'presentation'],
- canvas: ['img'],
- },
- ],
- 'jsx-a11y/no-noninteractive-element-interactions': [
- 'error',
- {
- handlers: [
- 'onClick',
- 'onError',
- 'onLoad',
- 'onMouseDown',
- 'onMouseUp',
- 'onKeyPress',
- 'onKeyDown',
- 'onKeyUp',
- ],
- alert: ['onKeyUp', 'onKeyDown', 'onKeyPress'],
- body: ['onError', 'onLoad'],
- dialog: ['onKeyUp', 'onKeyDown', 'onKeyPress'],
- iframe: ['onError', 'onLoad'],
- img: ['onError', 'onLoad'],
- },
- ],
- 'jsx-a11y/no-noninteractive-element-to-interactive-role': [
- 'error',
- {
- ul: ['listbox', 'menu', 'menubar', 'radiogroup', 'tablist', 'tree', 'treegrid'],
- ol: ['listbox', 'menu', 'menubar', 'radiogroup', 'tablist', 'tree', 'treegrid'],
- li: [
- 'menuitem',
- 'menuitemradio',
- 'menuitemcheckbox',
- 'option',
- 'row',
- 'tab',
- 'treeitem',
- ],
- table: ['grid'],
- td: ['gridcell'],
- fieldset: ['radiogroup', 'presentation'],
- },
- ],
- 'jsx-a11y/no-noninteractive-tabindex': [
- 'error',
- {
- tags: [],
- roles: ['tabpanel'],
- allowExpressionValues: true,
- },
- ],
- 'jsx-a11y/no-redundant-roles': 'error',
- 'jsx-a11y/no-static-element-interactions': [
- 'error',
- {
- allowExpressionValues: true,
- handlers: ['onClick', 'onMouseDown', 'onMouseUp', 'onKeyPress', 'onKeyDown', 'onKeyUp'],
- },
- ],
- 'jsx-a11y/role-has-required-aria-props': 'error',
- 'jsx-a11y/role-supports-aria-props': 'error',
- 'jsx-a11y/scope': 'error',
- 'jsx-a11y/tabindex-no-positive': 'error',
- },
- },
{
files: [
'packages/dify-ui/**/*.stories.{js,cjs,mjs,jsx,ts,tsx}',
diff --git a/oxlint-suppressions.json b/oxlint-suppressions.json
index 082500034b6..40f35d90bf2 100644
--- a/oxlint-suppressions.json
+++ b/oxlint-suppressions.json
@@ -2359,6 +2359,11 @@
"count": 5
}
},
+ "web/app/components/header/account-setting/model-provider-page/model-selector/popup-item.tsx": {
+ "jsx-a11y/no-static-element-interactions": {
+ "count": 1
+ }
+ },
"web/app/components/header/account-setting/model-provider-page/provider-added-card/cooldown-timer.tsx": {
"eslint-react/set-state-in-effect": {
"count": 1
@@ -2481,6 +2486,11 @@
"count": 1
}
},
+ "web/app/components/plugins/marketplace/home/home-trending.tsx": {
+ "jsx-a11y/no-static-element-interactions": {
+ "count": 1
+ }
+ },
"web/app/components/plugins/marketplace/hooks.ts": {
"@tanstack/query/prefer-query-options": {
"count": 3
@@ -4428,6 +4438,11 @@
"count": 4
}
},
+ "web/app/components/workflow/panel/version-history-panel/version-history-item.tsx": {
+ "jsx-a11y/no-static-element-interactions": {
+ "count": 1
+ }
+ },
"web/app/components/workflow/panel/workflow-preview.tsx": {
"jsx-a11y/click-events-have-key-events": {
"count": 4
@@ -4832,6 +4847,11 @@
"count": 2
}
},
+ "web/features/skills/detail/file-tree-items.tsx": {
+ "jsx-a11y/no-static-element-interactions": {
+ "count": 2
+ }
+ },
"web/features/tag-management/components/tag-item-editor.tsx": {
"jsx-a11y/no-autofocus": {
"count": 1
diff --git a/packages/dify-ui/src/dropdown-menu/__tests__/index.spec.tsx b/packages/dify-ui/src/dropdown-menu/__tests__/index.spec.tsx
index 9d65d038177..72edc4f9b11 100644
--- a/packages/dify-ui/src/dropdown-menu/__tests__/index.spec.tsx
+++ b/packages/dify-ui/src/dropdown-menu/__tests__/index.spec.tsx
@@ -296,6 +296,7 @@ describe('dropdown-menu wrapper', () => {
<DropdownMenu open>
<DropdownMenuTrigger aria-label="menu trigger">Open</DropdownMenuTrigger>
<DropdownMenuContent>
+ {/* oxlint-disable-next-line jsx-a11y/anchor-has-content -- Base UI merges this item's children and accessible name into the render element. */}
<DropdownMenuLinkItem render={<a href="/account" />} aria-label="account link">
Account settings
</DropdownMenuLinkItem>
diff --git a/web/scripts/a11y/oxlint.config.ts b/web/scripts/a11y/oxlint.config.ts
index 7a102d810a3..498ec50e834 100644
--- a/web/scripts/a11y/oxlint.config.ts
+++ b/web/scripts/a11y/oxlint.config.ts
@@ -1,10 +1,10 @@
import type { OxlintConfig } from 'vite-plus/lint'
-import { webJsxA11yRules } from '../../../lint.config.ts'
+import { jsxA11yRules } from '../../../lint.config.ts'
export default {
categories: {
correctness: 'off',
},
plugins: ['jsx-a11y'],
- rules: webJsxA11yRules,
+ rules: jsxA11yRules,
} satisfies OxlintConfig