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

Jump to bottom

Deprecate the className prop #799

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Deprecate the className prop #799

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ea2fa56
Deprecate the className prop
remcohaszing Nov 15, 2023
b2ce3ee
Remove the className prop entirely
remcohaszing Nov 17, 2023
82ae167
Remove unused type ElementContent
remcohaszing Nov 17, 2023
40143b1
Revert changelog changes
remcohaszing Nov 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,23 @@

All notable changes will be documented in this file.

## 9.0.1

### Deprecate `className`

The `className` prop was deprecated.
Not only does the `className` prop add the `className` prop, it also implies a
wrapper `<div>` will be created.
Instead, you should wrap the content in a `<div>` manually.

```jsx
<div className={className}>
<Markdown>
{children}
</Markdown>
</div>
```

## 9.0.0 - 2023-09-27

* [`b67d714`](https://github.com/remarkjs/react-markdown/commit/b67d714)
Expand Down
5 changes: 3 additions & 2 deletions lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ const deprecations = [
id: 'replace-allownode-allowedtypes-and-disallowedtypes',
to: 'allowedElements'
},
{from: 'className', id: 'deprecate-classname'},
{
from: 'disallowedTypes',
id: 'replace-allownode-allowedtypes-and-disallowedtypes',
Expand Down Expand Up @@ -266,8 +267,8 @@ export function Markdown(options) {
let remove = allowedElements
? !allowedElements.includes(node.tagName)
: disallowedElements
? disallowedElements.includes(node.tagName)
: false
? disallowedElements.includes(node.tagName)
: false

if (!remove && allowElement && typeof index === 'number') {
remove = !allowElement(node, index, parent)
Expand Down
2 changes: 0 additions & 2 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,8 +256,6 @@ Configuration (TypeScript type).
cannot combine w/ `disallowedElements`
* `children` (`string`, optional)
— markdown
* `className` (`string`, optional)
— wrap in a `div` with this class name
* `components` ([`Components`][api-components], optional)
— map tag names to components
* `disallowedElements` (`Array<string>`, default: `[]`)
Expand Down