Skip to content

[8.x] [A11y][APM] Improve aria-label for EuiCodeBlock on onboarding page (#217292) #217690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rmyz merged 2 commits into from
Apr 10, 2025
Merged

[8.x] [A11y][APM] Improve aria-label for EuiCodeBlock on onboarding page (#217292) #217690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9407c42
[A11y][APM] Improve `aria-label` for `EuiCodeBlock` on onboarding pag…
rmyz Apr 9, 2025
03cd84c
fix types
rmyz Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .../observability/plugins/apm/public/components/app/onboarding/agent_config_instructions.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
*/

import React from 'react';
import { i18n } from '@kbn/i18n';
import { EuiCodeBlock, EuiSpacer } from '@elastic/eui';
import {
getApmAgentCommands,
Expand Down Expand Up @@ -54,6 +55,13 @@ export function AgentConfigInstructions({

<EuiCodeBlock
isCopyable
copyAriaLabel={i18n.translate(
'xpack.apm.onboarding.agentConfigInstructions.euiCodeBlock.copyAriaLabel',
{
defaultMessage: 'Copy {variantId} agent configuration code',
values: { variantId },
}
)}
language={highlightLang || 'bash'}
data-test-subj="commands"
lineNumbers={lineNumbers}
Expand Down
8 changes: 7 additions & 1 deletion .../observability/plugins/apm/public/components/app/onboarding/instructions/django_agent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,13 @@ export const createDjangoAgentInstructions = (commonOptions: AgentInstructions):
})}
</EuiMarkdownFormat>
<EuiSpacer />
<EuiCodeBlock language="bash" isCopyable={true}>
<EuiCodeBlock
language="bash"
isCopyable={true}
copyAriaLabel={i18n.translate('xpack.apm.onboarding.django.install.copyAriaLabel', {
defaultMessage: 'Copy the code to install the APM agent for Django',
})}
>
$ pip install elastic-apm
</EuiCodeBlock>
</>
Expand Down
11 changes: 10 additions & 1 deletion .../observability/plugins/apm/public/components/app/onboarding/instructions/dotnet_agent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,16 @@ export const createDotNetAgentInstructions = (commonOptions: AgentInstructions):
})}
</EuiMarkdownFormat>
<EuiSpacer />
<EuiCodeBlock language="bash" isCopyable={true}>
<EuiCodeBlock
language="bash"
isCopyable={true}
copyAriaLabel={i18n.translate(
'xpack.apm.onboarding.dotNet.configureApplication.copyAriaLabel',
{
defaultMessage: 'Copy the code to add the APM agent to the dotnet application',
}
)}
>
{codeBlock}
</EuiCodeBlock>
<EuiSpacer />
Expand Down
8 changes: 7 additions & 1 deletion ...s/observability/plugins/apm/public/components/app/onboarding/instructions/flask_agent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,13 @@ export const createFlaskAgentInstructions = (commonOptions: AgentInstructions):
})}
</EuiMarkdownFormat>
<EuiSpacer />
<EuiCodeBlock language="bash" isCopyable={true}>
<EuiCodeBlock
language="bash"
isCopyable={true}
copyAriaLabel={i18n.translate('xpack.apm.onboarding.flask.install.copyAriaLabel', {
defaultMessage: 'Copy the code to install the APM agent for Flask',
})}
>
$ pip install elastic-apm[flask]
</EuiCodeBlock>
</>
Expand Down
16 changes: 14 additions & 2 deletions ...ions/observability/plugins/apm/public/components/app/onboarding/instructions/go_agent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,13 @@ func main() {
})}
</EuiMarkdownFormat>
<EuiSpacer />
<EuiCodeBlock language="bash" isCopyable={true}>
<EuiCodeBlock
language="bash"
isCopyable={true}
copyAriaLabel={i18n.translate('xpack.apm.onboarding.go.install.copyAriaLabel', {
defaultMessage: 'Copy the code to install the APM agent for Go',
})}
>
go get go.elastic.co/apm
</EuiCodeBlock>
</>
Expand Down Expand Up @@ -118,7 +124,13 @@ by using the tracer API directly.',
})}
</EuiMarkdownFormat>
<EuiSpacer />
<EuiCodeBlock language="go" isCopyable={true}>
<EuiCodeBlock
language="go"
isCopyable={true}
copyAriaLabel={i18n.translate('xpack.apm.onboarding.go.instrument.copyAriaLabel', {
defaultMessage: 'Copy the code to instrument your Go application',
})}
>
{codeBlock}
</EuiCodeBlock>
<EuiMarkdownFormat>
Expand Down
8 changes: 7 additions & 1 deletion ...ns/observability/plugins/apm/public/components/app/onboarding/instructions/node_agent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,13 @@ export const createNodeAgentInstructions = (commonOptions: AgentInstructions): E
})}
</EuiMarkdownFormat>
<EuiSpacer />
<EuiCodeBlock language="bash" isCopyable={true}>
<EuiCodeBlock
language="bash"
isCopyable={true}
copyAriaLabel={i18n.translate('xpack.apm.onboarding.node.install.copyAriaLabel', {
defaultMessage: 'Copy the code to install the APM agent for Node.js',
})}
>
npm install elastic-apm-node --save
</EuiCodeBlock>
</>
Expand Down
8 changes: 7 additions & 1 deletion ...ons/observability/plugins/apm/public/components/app/onboarding/instructions/php_agent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,13 @@ export const createPhpAgentInstructions = (commonOptions: AgentInstructions): Eu
})}
</EuiMarkdownFormat>
<EuiSpacer />
<EuiCodeBlock language="bash" isCopyable={true}>
<EuiCodeBlock
language="bash"
isCopyable={true}
copyAriaLabel={i18n.translate('xpack.apm.onboarding.php.installPackage.copyAriaLabel', {
defaultMessage: 'Copy the code to install the APM agent for PHP',
})}
>
apk add --allow-untrusted &lt;package-file&gt;.apk
</EuiCodeBlock>
<EuiSpacer />
Expand Down
16 changes: 14 additions & 2 deletions ...ns/observability/plugins/apm/public/components/app/onboarding/instructions/rack_agent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,13 @@ export const createRackAgentInstructions = (commonOptions: AgentInstructions): E
})}
</EuiMarkdownFormat>
<EuiSpacer />
<EuiCodeBlock language="bash" isCopyable={true}>
<EuiCodeBlock
language="bash"
isCopyable={true}
copyAriaLabel={i18n.translate('xpack.apm.onboarding.rack.install.copyAriaLabel', {
defaultMessage: 'Copy the code to install the APM agent for Rack',
})}
>
gem &apos;elastic-apm&apos;
</EuiCodeBlock>
</>
Expand All @@ -83,7 +89,13 @@ export const createRackAgentInstructions = (commonOptions: AgentInstructions): E
})}
</EuiMarkdownFormat>
<EuiSpacer />
<EuiCodeBlock language="bash" isCopyable={true}>
<EuiCodeBlock
language="bash"
isCopyable={true}
copyAriaLabel={i18n.translate('xpack.apm.onboarding.rack.configure.copyAriaLabel', {
defaultMessage: 'Copy the code to configure the APM agent for Rack',
})}
>
{codeBlock}
</EuiCodeBlock>
</>
Expand Down
8 changes: 7 additions & 1 deletion ...s/observability/plugins/apm/public/components/app/onboarding/instructions/rails_agent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,13 @@ export const createRailsAgentInstructions = (commonOptions: AgentInstructions):
})}
</EuiMarkdownFormat>
<EuiSpacer />
<EuiCodeBlock language="bash" isCopyable={true}>
<EuiCodeBlock
language="bash"
isCopyable={true}
copyAriaLabel={i18n.translate('xpack.apm.onboarding.rails.install.copyAriaLabel', {
defaultMessage: 'Copy the code to install the APM agent for Ruby on Rails',
})}
>
gem &apos;elastic-apm&apos;
</EuiCodeBlock>
</>
Expand Down
7 changes: 6 additions & 1 deletion ...solutions/observability/plugins/apm/public/components/app/onboarding/instructions_set.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
} from '@elastic/eui';
import React, { useMemo } from 'react';
import { useHistory } from 'react-router-dom';
import { css } from '@emotion/react';
import type {
INSTRUCTION_VARIANT,
InstructionVariant,
Expand Down Expand Up @@ -52,7 +53,11 @@ function InstructionTabs({
};

return (
<EuiTabs style={{ padding: `0 ${euiTheme.size.l}` }}>
<EuiTabs
css={css`
padding: 0 ${euiTheme.size.l};
`}
>
{agentTabs.map((tab) => (
<EuiTab
key={tab.id}
Expand Down
8 changes: 8 additions & 0 deletions ...ions/observability/plugins/apm/public/tutorial/config_agent/agent_config_instructions.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import React from 'react';
import { EuiCodeBlock, EuiSpacer } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { OpenTelemetryInstructions } from './opentelemetry_instructions';
import {
getApmAgentCommands,
Expand Down Expand Up @@ -63,6 +64,13 @@ export function AgentConfigInstructions({

<EuiCodeBlock
isCopyable
copyAriaLabel={i18n.translate(
'xpack.apm.tutorial.apmAgents.agentConfigurationInstructions.copyAriaLabel',
{
defaultMessage: 'Copy {variantId} agent configuration code',
values: { variantId },
}
)}
language={highlightLang || 'bash'}
data-test-subj="commands"
lineNumbers={lineNumbers}
Expand Down