refactor(json-crdt-peritext-ui): 💡 rename plugin export symbols

streamich · Nov 12, 2024 · 0b585fa · 0b585fa
1 parent 43e86c6
commit 0b585fa
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/src/json-crdt-peritext-ui/__demos__/components/App.tsx b/src/json-crdt-peritext-ui/__demos__/components/App.tsx
@@ -22,7 +22,7 @@ export const App: React.FC = () => {
     <Provider theme={'light'}>
       <GlobalCss />
       <div style={{maxWidth: '690px', fontSize: '21px', lineHeight: '1.7em', margin: '32px auto'}}>
-        <PeritextView peritext={peritext} renderers={[cursorPlugin, renderers, debugRenderers({enabled: false})]} />
+        <PeritextView peritext={peritext} plugins={[cursorPlugin, renderers, debugRenderers({enabled: false})]} />
       </div>
     </Provider>
   );

diff --git a/src/json-crdt-peritext-ui/plugins/minimal/index.ts b/src/json-crdt-peritext-ui/plugins/minimal/index.ts
@@ -10,7 +10,7 @@ import type {PeritextPlugin} from '../../react/types';
 
 const h = React.createElement;
 
-export const renderers: PeritextPlugin = {
+export const defaultPlugin: PeritextPlugin = {
   text,
   caret: (props, children) => h(RenderCaret, <any>props, children),
   focus: (props, children) => h(RenderFocus, <any>props, children),

diff --git a/src/json-crdt-peritext-ui/react/PeritextView.tsx b/src/json-crdt-peritext-ui/react/PeritextView.tsx
@@ -4,7 +4,8 @@ import {context, type PeritextSurfaceContextValue} from './context';
 import {CssClass} from '../constants';
 import {BlockView} from './BlockView';
 import {DomController} from '../dom/DomController';
-import {renderers as defaultRenderers} from '../plugins/minimal';
+import {cursorPlugin} from '../plugins/cursor';
+import {defaultPlugin} from '../plugins/minimal';
 import type {Peritext} from '../../json-crdt-extensions/peritext/Peritext';
 import type {PeritextPlugin} from './types';
 
@@ -33,13 +34,13 @@ put('.' + CssClass.Inline, {
  */
 export interface PeritextViewProps {
   peritext: Peritext;
-  renderers?: PeritextPlugin[];
+  plugins?: PeritextPlugin[];
   onRender?: () => void;
 }
 
 /** @todo Is `React.memo` needed here? */
 export const PeritextView: React.FC<PeritextViewProps> = React.memo((props) => {
-  const {peritext, renderers = [defaultRenderers], onRender} = props;
+  const {peritext, plugins = [cursorPlugin, defaultPlugin], onRender} = props;
   const [, setTick] = React.useState(0);
   const [dom, setDom] = React.useState<DomController | undefined>(undefined);
 
@@ -71,8 +72,8 @@ export const PeritextView: React.FC<PeritextViewProps> = React.memo((props) => {
   );
 
   const ctx: undefined | PeritextSurfaceContextValue = React.useMemo(
-    () => (dom ? {peritext, dom, renderers, rerender} : undefined),
-    [peritext, dom, renderers, rerender],
+    () => (dom ? {peritext, dom, renderers: plugins, rerender} : undefined),
+    [peritext, dom, plugins, rerender],
   );
 
   const block = peritext.blocks.root;
@@ -88,7 +89,7 @@ export const PeritextView: React.FC<PeritextViewProps> = React.memo((props) => {
     </div>
   );
 
-  for (const map of renderers) children = map.peritext?.(props, children, ctx) ?? children;
+  for (const map of plugins) children = map.peritext?.(props, children, ctx) ?? children;
 
   return children;
 });