Skip to content
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

[Docs] Fix EuiMarkdownEditor plugin example polluting other examples #7929

Merged
merged 2 commits into from
Jul 29, 2024
Merged

[Docs] Fix EuiMarkdownEditor plugin example polluting other examples #7929

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
7fee0d9
Fix custom plugin that was mutating the default plugins
cee-chen Jul 29, 2024
e36efa8
Update snippet as well
cee-chen Jul 29, 2024
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
21 changes: 12 additions & 9 deletions packages/eui/src-docs/src/views/markdown_editor/markdown_link_validation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,18 @@ import {
EuiMarkdownFormat,
} from '../../../../src/components';

// find the validation plugin and configure it to only allow https: and mailto: links
const parsingPlugins = getDefaultEuiMarkdownParsingPlugins();
parsingPlugins.find(([plugin, config]) => {
const isValidationPlugin = plugin === euiMarkdownLinkValidator;
if (isValidationPlugin) {
config.allowProtocols = ['https:', 'mailto:'];
}
return isValidationPlugin;
});
const parsingPlugins = [
// Exclude the default validation plugin, we're configuring our own that excludes `http` as a protocol
...getDefaultEuiMarkdownParsingPlugins({
exclude: ['linkValidator'],
}),
[
euiMarkdownLinkValidator,
{
allowProtocols: ['https:', 'mailto:'],
},
],
];

const markdown = `**Standalone links**
https://example.com
Expand Down
40 changes: 18 additions & 22 deletions packages/eui/src-docs/src/views/markdown_editor/markdown_plugin_example.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,28 +327,24 @@ export const MarkdownPluginExample = {
</Fragment>
),
snippet: [
`// change what link protocols are allowed
const parsingPlugins = getDefaultEuiMarkdownParsingPlugins();
parsingPlugins.find(([plugin, config]) => {
const isValidationPlugin = plugin === euiMarkdownLinkValidator;
if (isValidationPlugin) {
config.allowProtocols = ['https:', 'mailto:'];
}
return isValidationPlugin;
});`,
`// filter out the link validation plugin
const parsingPlugins = getDefaultEuiMarkdownParsingPlugins().filter(([plugin]) => {
return plugin !== euiMarkdownLinkValidator;
});`,
`// disable relative urls
const parsingPlugins = getDefaultEuiMarkdownParsingPlugins();
parsingPlugins.find(([plugin, config]) => {
const isValidationPlugin = plugin === euiMarkdownLinkValidator;
if (isValidationPlugin) {
config.allowRelative = false;
}
return isValidationPlugin;
});`,
`// customize what link protocols are allowed
const parsingPlugins = [
...getDefaultEuiMarkdownParsingPlugins({
// Exclude the default validation plugin - we're configuring our own
exclude: ['linkValidator'],
}),
[
euiMarkdownLinkValidator,
{
// Customize what link protocols are allowed
allowProtocols: ['https:', 'mailto:'],
},
]
];

// Pass the customized parsing plugins to your markdown component
<EuiMarkdownFormat parsingPlugins={parsingPlugins} />
`,
],
demo: <LinkValidation />,
},
Expand Down
Loading