-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
75 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,79 @@ | ||
# 1.2.6 | ||
# 2.0.0 | ||
|
||
- Replace with svg icon | ||
## Features | ||
|
||
# 1.2.2 | ||
### Use @swc/wasm-web instead of babel to compile code in the browser. | ||
|
||
- Fixed component not rendering when the code property value was updated. | ||
Importing `babel.min.js` on the page will no longer be required. [How it is used in v1](https://github.com/simonguo/react-code-view/blob/1.2.6/README.md#add-babel) | ||
|
||
# 1.2.0 | ||
### Refactored webpack loader for markdown. | ||
|
||
- Update dependencies | ||
- _Breaking_ react-markdown-reader@1.2.0 | ||
- _Breaking_ markdown-loader@5.0.0 | ||
```js | ||
|
||
// v1 | ||
|
||
export default { | ||
module: { | ||
rules: [ | ||
{ | ||
test: /\.md$/, | ||
use: [{ | ||
loader: 'html-loader' | ||
}, { | ||
loader: 'markdown-loader', | ||
options: { | ||
renderer: markdownRenderer() | ||
} | ||
}] | ||
} | ||
] | ||
|
||
} | ||
}; | ||
|
||
// v2 | ||
export default { | ||
module: { | ||
rules: [ | ||
{ | ||
test: /\.md$/, | ||
use:[ | ||
loader: 'react-code-view/webpack-md-loader', | ||
options:{ | ||
parseLanguages: ['typescript','rust'] | ||
} | ||
] | ||
} | ||
] | ||
} | ||
}; | ||
``` | ||
|
||
### Props redefined | ||
|
||
**v1** | ||
|
||
| Name | Type | Default value | Description | | ||
| --------------------- | -------- | ------------------------------------------- | ------------------------------------------------- | | ||
| babelTransformOptions | Object | { presets: ['stage-0', 'react', 'es2015'] } | Babel configuration parameters [options][babeljs] | | ||
| dependencies | Object | | Dependent components. | | ||
| renderToolbar | Function | | Custom toolbar. | | ||
| showCode | boolean | true | Display code. | | ||
| theme | string | 'light' | Theme, options `light` and `dark`. | | ||
|
||
**v2** | ||
|
||
| Name | Type | Default value | Description | | ||
| -------------- | --------------------------------- | ----------------------- | ------------------------------------------------------------------------- | | ||
| afterCompile | (code: string) => string | | Executed after compiling the code | | ||
| beforeCompile | (code: string) => string | | Executed before compiling the code | | ||
| children | any | | The code to be rendered is executed. Usually imported via markdown-loader | | ||
| compiler | (code: string) => string | | A compiler that transforms the code. Use swc.transformSync by default | | ||
| dependencies | object | | Dependent objects required by the executed code | | ||
| editable | boolean | false | Renders a code editor that can modify the source code | | ||
| editor | object | | Editor properties | | ||
| onChange | (code?: string) => void | | Callback triggered after code change | | ||
| renderToolbar | (buttons: ReactNode) => ReactNode | | Customize the rendering toolbar | | ||
| sourceCode | string | | The code to be rendered is executed | | ||
| theme | 'light' , 'dark' | 'light' | Code editor theme, applied to CodeMirror | | ||
| compileOptions | object | defaultTransformOptions | swc configuration https://swc.rs/docs/configuration/compilation | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters