Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add zebra-stripes component. #424
- Loading branch information
1 parent
7bd0ed7
commit bdb7e9a
Showing
11 changed files
with
359 additions
and
1 deletion.
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
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
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 |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| <!--rehype:ignore:start--> | ||
|
|
||
| # Zebra Stripes Extensions | ||
|
|
||
| <!--rehype:ignore:end--> | ||
|
|
||
| [](https://www.npmjs.com/package/@uiw/codemirror-extensions-mentions) | ||
|
|
||
| Styles alternating lines for CodeMirror6. | ||
|
|
||
| [](https://uiwjs.github.io/react-codemirror/#/extensions/mentions) | ||
|
|
||
| ## Install | ||
|
|
||
| ```bash | ||
| npm install @uiw/codemirror-zebra-stripes --save | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```jsx | ||
| import CodeMirror from '@uiw/react-codemirror'; | ||
| import { zebraStripes } from '@uiw/codemirror-zebra-stripes'; | ||
|
|
||
| function App() { | ||
| return <CodeMirror value="" height="200px" extensions={[zebraStripes({ step: 2 })]} />; | ||
| } | ||
| export default App; | ||
| ``` | ||
|
|
||
| ```jsx | ||
| import CodeMirror from '@uiw/react-codemirror'; | ||
| import { zebraStripes } from '@uiw/codemirror-zebra-stripes'; | ||
|
|
||
| function App() { | ||
| return ( | ||
| <CodeMirror | ||
| value="" | ||
| height="200px" | ||
| extensions={[ | ||
| zebraStripes({ | ||
| lineNumber: [1, [3, 6], 10], | ||
| lightColor: '#aca2ff33', | ||
| darkColor: '#aca2ff40', | ||
| }), | ||
| ]} | ||
| /> | ||
| ); | ||
| } | ||
| export default App; | ||
| ``` | ||
|
|
||
| ```js | ||
| import { EditorView } from '@codemirror/view'; | ||
| import { EditorState } from '@codemirror/state'; | ||
| import { mentions } from '@uiw/codemirror-zebra-stripes'; | ||
|
|
||
| const state = EditorState.create({ | ||
| doc: 'my source code', | ||
| extensions: [zebraStripes({ step: 2 })], | ||
| }); | ||
|
|
||
| const view = new EditorView({ | ||
| parent: document.querySelector('#editor'), | ||
| state, | ||
| }); | ||
| ``` | ||
|
|
||
| ## API | ||
|
|
||
| ```ts | ||
| import { Extension } from '@codemirror/state'; | ||
| export declare type ZebraStripesOptions = { | ||
| step?: number | null; | ||
| lightColor?: string; | ||
| darkColor?: string; | ||
| /** | ||
| * @example `[1,[2,6], 10]` | ||
| */ | ||
| lineNumber?: (number | number[])[] | null; | ||
| }; | ||
| export declare function zebraStripes(options?: ZebraStripesOptions): Extension; | ||
| ``` | ||
|
|
||
| ## Contributors | ||
|
|
||
| As always, thanks to our amazing contributors! | ||
|
|
||
| <a href="https://github.com/uiwjs/react-codemirror/graphs/contributors"> | ||
| <img src="https://uiwjs.github.io/react-codemirror/CONTRIBUTORS.svg" /> | ||
| </a> | ||
|
|
||
| Made with [github-action-contributors](https://github.com/jaywcjlove/github-action-contributors). | ||
|
|
||
| ## License | ||
|
|
||
| Licensed under the MIT License. |
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 |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| { | ||
| "name": "@uiw/codemirror-extensions-zebra-stripes", | ||
| "version": "4.15.1", | ||
| "description": "Styles alternating lines for CodeMirror6.", | ||
| "homepage": "https://uiwjs.github.io/react-codemirror/#/extensions/zebra-stripes", | ||
| "author": "kenny wong <wowohoo@qq.com>", | ||
| "license": "MIT", | ||
| "main": "./cjs/index.js", | ||
| "module": "./esm/index.js", | ||
| "scripts": { | ||
| "watch": "tsbb watch", | ||
| "build": "tsbb build" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/uiwjs/react-codemirror.git" | ||
| }, | ||
| "files": [ | ||
| "src", | ||
| "esm", | ||
| "cjs" | ||
| ], | ||
| "peerDependencies": { | ||
| "@codemirror/state": ">=6.0.0", | ||
| "@codemirror/view": ">=6.0.0" | ||
| }, | ||
| "devDependencies": { | ||
| "@codemirror/state": "^6.1.0", | ||
| "@codemirror/view": "^6.0.0" | ||
| }, | ||
| "keywords": [ | ||
| "codemirror", | ||
| "codemirror6", | ||
| "zebra-stripes", | ||
| "extensions", | ||
| "ide", | ||
| "code" | ||
| ], | ||
| "jest": { | ||
| "coverageReporters": [ | ||
| "lcov", | ||
| "json-summary" | ||
| ] | ||
| } | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| import { Extension } from '@codemirror/state'; | ||
| import { Facet, RangeSetBuilder } from '@codemirror/state'; | ||
| import { EditorView, Decoration, ViewPlugin, DecorationSet, ViewUpdate } from '@codemirror/view'; | ||
|
|
||
| const lineNumber = Facet.define({ | ||
| combine: (values) => { | ||
| return values.length && Array.isArray(values) ? values.flat() : []; | ||
| }, | ||
| }); | ||
|
|
||
| const stepSize = Facet.define({ | ||
| combine: (values) => { | ||
| return values.length && Array.isArray(values) ? Math.min(...values) : 2; | ||
| }, | ||
| }); | ||
|
|
||
| const stripe = Decoration.line({ | ||
| attributes: { class: 'cm-zebra-stripe' }, | ||
| }); | ||
|
|
||
| function stripeDeco(view: EditorView) { | ||
| const step = view.state.facet(stepSize); | ||
| const num = view.state.facet(lineNumber); | ||
| const builder = new RangeSetBuilder<Decoration>(); | ||
| for (let { from, to } of view.visibleRanges) { | ||
| for (let pos = from; pos <= to; ) { | ||
| let line = view.state.doc.lineAt(pos); | ||
|
|
||
| if (line.number % step === 0 && num.length === 0) { | ||
| builder.add(line.from, line.from, stripe); | ||
| } | ||
| if (num.length > 0 && num.flat().includes(line.number)) { | ||
| builder.add(line.from, line.from, stripe); | ||
| } | ||
| pos = line.to + 1; | ||
| } | ||
| } | ||
| return builder.finish(); | ||
| } | ||
|
|
||
| const showStripes = ViewPlugin.fromClass( | ||
| class { | ||
| decorations: DecorationSet; | ||
| constructor(view: EditorView) { | ||
| this.decorations = stripeDeco(view); | ||
| } | ||
|
|
||
| update(update: ViewUpdate) { | ||
| this.decorations = stripeDeco(update.view); | ||
| // if (update.docChanged || update.viewportChanged) { | ||
| // this.decorations = stripeDeco(update.view); | ||
| // } | ||
| } | ||
| }, | ||
| { | ||
| decorations: (v) => v.decorations, | ||
| }, | ||
| ); | ||
|
|
||
| const baseTheme = (opt: Pick<Partial<ZebraStripesOptions>, 'lightColor' | 'darkColor'> = {}) => { | ||
| return EditorView.baseTheme({ | ||
| '&light .cm-zebra-stripe': { backgroundColor: opt.lightColor || '#eef6ff' }, | ||
| '&dark .cm-zebra-stripe': { backgroundColor: opt.darkColor || '#3a404d' }, | ||
| }); | ||
| }; | ||
|
|
||
| export type ZebraStripesOptions = { | ||
| step?: number | null; | ||
| lightColor?: string; | ||
| darkColor?: string; | ||
| /** | ||
| * @example `[1,[2,6], 10]` | ||
| */ | ||
| lineNumber?: (number | number[])[] | null; | ||
| }; | ||
|
|
||
| const range = (start: number, stop: number, step: number) => | ||
| Array.from({ length: (stop - start) / step + 1 }, (_, i) => start + i * step); | ||
|
|
||
| export function zebraStripes(options: ZebraStripesOptions = {}): Extension { | ||
| const zebraStripeTheme = baseTheme({ lightColor: options.lightColor, darkColor: options.darkColor }); | ||
| if (options.lineNumber && Array.isArray(options.lineNumber)) { | ||
| options.step = null; | ||
| options.lineNumber = options.lineNumber.map((item) => { | ||
| if (Array.isArray(item) && typeof item[0] === 'number' && typeof item[1] === 'number') { | ||
| return range(item[0], item[1], 1); | ||
| } | ||
| return item; | ||
| }); | ||
| } else { | ||
| options.lineNumber = null; | ||
| } | ||
| return [ | ||
| options.lineNumber === null ? [] : lineNumber.of(options.lineNumber || []), | ||
| options.step === null ? [] : stepSize.of(options.step || 2), | ||
| showStripes, | ||
| zebraStripeTheme, | ||
| ]; | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "extends": "../../tsconfig", | ||
| "include": ["src"], | ||
| "compilerOptions": { | ||
| "outDir": "./cjs", | ||
| "baseUrl": ".", | ||
| "noEmit": false | ||
| } | ||
| } |
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
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
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
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 |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| import data from '@uiw/codemirror-extensions-zebra-stripes/README.md'; | ||
| import { zebraStripes } from '@uiw/codemirror-extensions-zebra-stripes'; | ||
| import CodeMirror, { ReactCodeMirrorProps } from '@uiw/react-codemirror'; | ||
| import { useEffect, useState } from 'react'; | ||
| import { langs } from '@uiw/codemirror-extensions-langs'; | ||
|
|
||
| export const LineNumberDemo = () => { | ||
| const dark = document.documentElement.getAttribute('data-color-mode'); | ||
| const [theme, setTheme] = useState<ReactCodeMirrorProps['theme']>(dark === 'dark' ? 'dark' : 'light'); | ||
| useEffect(() => { | ||
| setTheme(document.documentElement.getAttribute('data-color-mode') === 'dark' ? 'dark' : 'light'); | ||
| document.addEventListener('colorschemechange', (e) => { | ||
| setTheme(e.detail.colorScheme as ReactCodeMirrorProps['theme']); | ||
| }); | ||
| }, []); | ||
|
|
||
| return ( | ||
| <CodeMirror | ||
| value={data.source} | ||
| theme={theme} | ||
| height="300px" | ||
| style={{ margin: '0 0 23px 0' }} | ||
| extensions={[ | ||
| langs.markdown(), | ||
| zebraStripes({ lineNumber: [1, [3, 6], 10], lightColor: '#aca2ff33', darkColor: '#aca2ff40' }), | ||
| ]} | ||
| /> | ||
| ); | ||
| }; |
Oops, something went wrong.