Created @scriptural/react package by abelpz · Pull Request #221 · eten-tech-foundation/scripture-editors

abelpz · 2024-12-31T19:54:20Z

Created lexical editor package for supporting usj

This change is

# Conflicts: # pnpm-lock.yaml

- update lock file - fix USJ version from `usfm2Usj` - revert unintentional changes - move nodes menu CSS - fix menu closing when typing (improve selection change detection) - pass in `scrRef` to plugin - get `contextMarker` - add poetry quote marker overwrites

…xus-Foundation/scripture-editors into scriptural-react

codesandbox · 2024-12-31T19:54:23Z

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

- now at cursor rather than top-left

nx-cloud · 2025-01-07T23:19:39Z

View your CI Pipeline Execution ↗ for commit dbb4255.

Command	Status	Duration	Result
`nx run-many -t test`	❌ Failed	33s	View ↗
`nx run-many -t lint`	✅ Succeeded	1s	View ↗
`nx run-many -t typecheck`	✅ Succeeded	25s	View ↗

☁️ Nx Cloud last updated this comment at 2025-01-13 15:50:54 UTC

netlify · 2025-01-11T21:53:17Z

❌ Deploy Preview for quick-draft failed. Why did it fail? →

Name	Link
🔨 Latest commit	`c799f4a`
🔍 Latest deploy log	https://app.netlify.com/projects/quick-draft/deploys/68e6f2fcd644e3000958cf4c

irahopkinson

I'm publishing this partial review for now since GH is acting weird.

irahopkinson · 2025-01-15T01:01:56Z

This file was out of date when I checked out the branch. Run pnpm i to update this file.

irahopkinson

Next partial review (GH still acting weird - perhaps its is the large number of files)

irahopkinson

Another partial review. I've run out of week now. I'll get back to this when I get back after next week. Sorry for the delay.

irahopkinson · 2025-01-16T02:53:42Z

+  content?: UsjParaContent[];
+  "link-id"?: NonWhitespaceString;
+  "link-href"?: NonWhitespaceString;
+  [key: `x-${string}`]: string;


You should add [key: z-${string}]: string;. See https://docs.usfm.bible/usfm/3.1.1/char/attributes.html#_user_defined_attributes

I thought x- prefix was for custom attributes and z prefix for custom markers, the link you provided doesn't provide an example for z- attributes. Could it be a mistake in the docs?

I checked with the head of the USX/J/FM committee and it should be both x- and z- for properties. He helped me understand more about this if you want to chat in more detail.

irahopkinson

Finally getting back to this review. It would be good to talk about your USJ nodes and if we can combine our usage of nodes.

irahopkinson · 2025-02-13T23:12:18Z

If you delete this file I think we will have trouble publishing to NPM. Was this file causing some issue?

irahopkinson · 2025-02-23T21:27:26Z

+  });
+}
+
 export type ScriptureReference = {


You should now import ScriptureReference from "shared/utils/get-marker-action.model" to keep consistent across the repo.

irahopkinson · 2025-02-23T21:45:44Z

+      root: ({ children }) => {
+        return {
+          type: "USJ",
+          version: "0.2.1",


The latest is v3.1. See main for this update.

irahopkinson · 2025-02-23T21:54:34Z

+    lastTextObject: null,
+  };
+
+  function $isSerializedTextNode(node: SerializedLexicalNode): node is SerializedTextNode {


This function name doesn't strictly need to start with '$' and probably shouldn't since you are dealing with serialized data (rather than an instantiated Node).

irahopkinson · 2025-02-23T21:56:57Z

+    lastTextObject: null,
+  };
+
+  function $isSerializedTextNode(node: SerializedLexicalNode): node is SerializedTextNode {


You should add | null | undefined to the node argument type. You could also simplify the last two checks to node?.type === "text".

irahopkinson · 2025-02-23T23:47:58Z

+} from "lexical";
+
+export const createSerializedRootNode = (children: SerializedLexicalNode[]): SerializedRootNode => {
+  return {


For both these functions I would just use the simplified arrow function return format, i.e. ... => { ...<someObjectContent>... };

irahopkinson · 2025-02-23T23:51:56Z

+export type SerializedBlockNode = SerializedScriptureElementNode;
+
+export class BlockNode extends ScriptureElementNode {
+  constructor(attributes: Attributes = {}, props?: NodeProps, tag?: string, key?: NodeKey) {


You can remove this constructor since the super constructor does the same thing.

irahopkinson · 2025-02-23T23:57:11Z

+export type SerializedInlineNode = SerializedScriptureElementNode;
+
+export class InlineNode extends ScriptureElementNode {
+  constructor(attributes: Attributes = {}, props?: NodeProps, tag?: string, key?: NodeKey) {


You can also remove this constructor since the super constructor does the same thing.

irahopkinson · 2025-02-24T00:03:50Z

 export type Attributes = { [key: string]: string };

-export type SerializedUsfmElementNode = Spread<
+export type SerializedScriptureElementNode = Spread<


Are you sure this should be renamed? It now clashes with another type of that same name. I would revert the 2 changes to this file if its not intentional.

irahopkinson · 2025-02-24T00:16:51Z

+    }
+  };
+
+  let nodeType: UsjNode["type"] | undefined = undefined;


NIT: assigning to undefined isn't needed since declaring it makes it undefined.

…al app - Introduced `AppReferenceHandler` to manage scripture references across editors. - Enhanced `Editor` and `AppBar` components to utilize the new reference handler. - Added `ScriptureNavigator` component for user-friendly navigation between scripture references. - Integrated `ScrollToReferencePlugin` to automatically scroll to the current reference in the editor. - Updated context and props to support scripture reference handling throughout the application.

…al editor lib and app (#301)

…erencePlugin` to clean up the code.

…ct import

- Added `findVerseInChapterContext` function to locate verses considering their chapter context. - Implemented helper functions `isElementAfter` and `isElementBefore` to determine element positioning in the document. - Updated `scrollToReference` to utilize the new verse-finding logic.

- Added `FindReplacePlugin` to provide find and replace capabilities. - Introduced `FindReplaceDialog` component for user interface. - Integrated `SearchButton` in `CustomToolbar` to toggle the find and replace dialog. - Updated `Editor` and related components to support the new functionality. - Enhanced context management for search and replace operations.

…t import

…ality - Added `TriggerKeyButton` to `CustomToolbar` for setting trigger key combinations. - Integrated `TriggerKeyDialog` for user interaction with trigger keys. - Updated `CustomToolbar` to include `ScripturalNodesMenuPlugin` and `CustomMarkersToolbar`. - Wrapped `CustomToolbar` in `MarkersMenuProvider` within the `Editor` component for improved context management. - Refactored toolbar layout for better organization and usability.

…remove unused imports

…reamline functionality

…ine component functionality

…to improve code clarity

…ural editor - Introduced `CustomSaveButton` in `CustomToolbar` to replace the previous `SaveButton`, adding support for unsaved changes indication. - Implemented `useUnsavedChanges` hook in the `Editor` component to manage unsaved changes and integrate with the `HistoryPlugin`. - Updated `SaveButton` to include automatic change detection and visual feedback for unsaved changes. - Enhanced documentation to reflect new features and usage examples for tracking unsaved changes.

abelpz and others added 9 commits December 16, 2024 15:22

reuse nodes menu in platform

e5d2943

# Conflicts: # pnpm-lock.yaml

Merge branch 'main' into abelpz-reuse-nodes-menu

46d68eb

Fix some things

9004922

- update lock file - fix USJ version from `usfm2Usj` - revert unintentional changes - move nodes menu CSS - fix menu closing when typing (improve selection change detection) - pass in `scrRef` to plugin - get `contextMarker` - add poetry quote marker overwrites

refactor making getMakerAction different per editor

c536f7d

get USJ marker action

03f5ea9

added alignment support

e27a702

Merge branch 'abelpz-reuse-nodes-menu' of https://github.com/BiblioNe…

0dc70e1

…xus-Foundation/scripture-editors into scriptural-react

updae lock file

6878c53

new-scriptural-react-package

703344b

abelpz and others added 12 commits December 31, 2024 17:14

added docs

8e91625

fix field-test found issues

470ec25

fix menu location on empty paragraph

d026938

- now at cursor rather than top-left

platform: add menu trigger property

97dc98e

platform fix: BCV when c & v inserted

385d234

fix scriptural marker nodes bugs with footnotes

c9e7f5e

added alignment support

1d1dd00

updae lock file

daeac26

new-scriptural-react-package

d9753a0

added docs

b9c1243

fix field-test found issues

8fead7f

fix scriptural marker nodes bugs with footnotes

ecc9a66

abelpz force-pushed the scriptural-react branch from c9e7f5e to ecc9a66 Compare January 7, 2025 23:07

abelpz added 2 commits January 7, 2025 19:13

update package-lock

2f75212

fix css

382fea5

abelpz added 4 commits January 7, 2025 19:21

removed debugger

8cf6a34

fix relative path error

c229515

removed unused imports

fe60c53

delete schemas folder

92416ee

abelpz added 6 commits January 11, 2025 14:07

make scriptureReferencePlugin update on verse of chapter update

3d5f94b

improved scriptural-app and examples of persistence

cf02350

fix css style format issues

c784522

downgraded esling config to traditional format

0d3d887

fix build warnings

bdc5c61

further modularize toolbar buttons

94de6b0

abelpz added 4 commits January 11, 2025 17:59

removed unused import

f1b1c32

fixed tailwind config for scriptural-app

79b6d9e

added persistance examples to scriptural app

faaef41

fixed extra whitespaces being added in usj to lexical conversion

dbb4255

irahopkinson reviewed Jan 16, 2025

View reviewed changes

fix PR review comments

0b8edd3

irahopkinson requested changes Feb 24, 2025

View reviewed changes

abelpz added 14 commits April 23, 2025 21:49

Implement scripture reference handling and navigation in the scriptur…

b19a6cb

…al editor lib and app (#301)

Remove unused import of useLexicalComposerContext from `ScrollToRef…

1e2853c

…erencePlugin` to clean up the code.

Refactor imports in ScriptureNavigator component to remove unused Rea…

ef0853b

…ct import

Refactor imports in FindReplaceDialog component to remove unused Reac…

c1f60c6

…t import

Refactor imports in CustomToolbar and TriggerKeyDialog components to …

1b4b9e6

…remove unused imports

Remove unused option selection handler from NodesMenu component to st…

c6687b3

…reamline functionality

Remove unused ScripturalNodesMenuPlugin from CustomToolbar to streaml…

3aa2d67

…ine component functionality

Remove unused import of ScripturalNodesMenuPlugin from CustomToolbar …

2413240

…to improve code clarity

Update version in package.json for @scriptural/react to 0.0.22

c799f4a

Conversation

abelpz commented Dec 31, 2024 • edited by irahopkinson Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codesandbox Bot commented Dec 31, 2024

Review or Edit in CodeSandbox

Uh oh!

nx-cloud Bot commented Jan 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify Bot commented Jan 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ Deploy Preview for quick-draft failed. Why did it fail? →

Uh oh!

irahopkinson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

irahopkinson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

irahopkinson left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

irahopkinson left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

abelpz commented Dec 31, 2024 •

edited by irahopkinson

Loading

nx-cloud Bot commented Jan 7, 2025 •

edited

Loading

netlify Bot commented Jan 11, 2025 •

edited

Loading