Skip to content

[MarkdownEditor] Add className support to toolbar for custom styling #9349

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
weronikaolejniczak merged 3 commits into from
Feb 2, 2026
Merged

[MarkdownEditor] Add className support to toolbar for custom styling #9349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
68b0fa1
[MarkdownEditor] Add className support to toolbar for custom styling
ragini-pandey Jan 31, 2026
b32fef4
Merge branch 'main' into feat/markdown-editor-toolbar-classname
ragini-pandey Jan 31, 2026
bb869f9
[MarkdownEditor] Add changelog entry for className support in toolbar…
ragini-pandey Feb 2, 2026
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
1 change: 1 addition & 0 deletions packages/eui/changelogs/upcoming/9349.md
View file
Open in desktop
Copy link
Copy Markdown
Contributor

@weronikaolejniczak weronikaolejniczak Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ragini-pandey this filename needs to be: 9349.md, same as your PR number! 😄

Copy link
Copy Markdown
Contributor Author

@ragini-pandey ragini-pandey Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohk Thanks. I thought it was an issue number.
Renamed!

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Added `className` support to `EuiMarkdownEditor`'s `toolbarProps` for custom toolbar styling
14 changes: 14 additions & 0 deletions packages/eui/src/components/markdown_editor/markdown_editor.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,20 @@ describe('EuiMarkdownEditor', () => {
screen.getByRole('button', { name: 'Editor' })
).toBeInTheDocument();
});

it('applies custom className to toolbar when passed', () => {
render(
<EuiMarkdownEditor
onChange={() => null}
value="markdown test"
{...requiredProps}
toolbarProps={{ className: 'customToolbarClass' }}
/>
);
const toolbar = screen.getByTestSubject('euiMarkdownEditorToolbar');
expect(toolbar).toHaveClass('euiMarkdownEditorToolbar');
expect(toolbar).toHaveClass('customToolbarClass');
});
});
it('should show footer by default and hide when showFooter is false', () => {
render(
Expand Down
1 change: 1 addition & 0 deletions packages/eui/src/components/markdown_editor/markdown_editor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ type CommonMarkdownEditorProps = Omit<
* Props to customize the toolbar. `right` replaces the default preview/editor toggle with custom content.
*/
toolbarProps?: {
className?: EuiMarkdownEditorToolbarProps['className'];
right?: EuiMarkdownEditorToolbarProps['right'];
};
/** Controls whether the footer is shown */
Expand Down
6 changes: 5 additions & 1 deletion packages/eui/src/components/markdown_editor/markdown_editor_toolbar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import React, {
forwardRef,
Ref,
} from 'react';
import classNames from 'classnames';

import { useEuiMemoizedStyles } from '../../services';
import { CommonProps } from '../common';
Expand Down Expand Up @@ -140,6 +141,7 @@ export const EuiMarkdownEditorToolbar = forwardRef<
>(
(
{
className,
markdownActions,
viewMode,
onClickPreview,
Expand All @@ -151,6 +153,8 @@ export const EuiMarkdownEditorToolbar = forwardRef<
) => {
const { openPluginEditor, readOnly } = useContext(EuiMarkdownContext);

const classes = classNames('euiMarkdownEditorToolbar', className);

const handleMdButtonClick = (mdButtonId: string) => {
const actionResult = markdownActions.do(mdButtonId);
if (actionResult !== true) openPluginEditor(actionResult);
Expand All @@ -166,7 +170,7 @@ export const EuiMarkdownEditorToolbar = forwardRef<
<div
ref={ref}
css={styles.euiMarkdownEditorToolbar}
className="euiMarkdownEditorToolbar"
className={classes}
data-test-subj="euiMarkdownEditorToolbar"
>
<div
Expand Down