Added <hr> tag functionlity #52

Vishalk91-4 · 2024-10-05T05:56:58Z

Signed-off-by: Vishal korada.vishal.phe22@itbhu.ac.in

Does this PR affect any open issues?

Y
re Add support for <hr /> tag #42

The scope of this PR:
xml-builder.js
render-document-file.js
example/example.js
example/example-node.js
App.js
Description of the PR

Added hr tag functionality

Breaking changes?(Y/N):

N
Y

@K-Kumar-01 , @nicolasiscoding could you please review this PR

Signed-off-by: Vishal <korada.vishal.phe22@itbhu.ac.in>

nicolasiscoding

Nice first pass. Code not tested, just style review

nicolasiscoding · 2024-10-05T17:46:50Z

src/helpers/xml-builder.js

+  const hrFragment = fragment({ namespaceAlias: { w: namespaces.w } }).ele('@w', 'p');
+  const pPr = hrFragment.ele('@w', 'pPr');
+  const pBdr = pPr.ele('@w', 'pBdr');
+  pBdr.ele('@w', 'bottom', {


Small pieces of feedback -

Can you see if we can grab the parameters from the style tag to make this dynamic? You can see a few styles here https://www.w3schools.com/tags/tag_hr.asp but recommend testing with what TinyMCE supports too.

If there are no styles applied can we pull the defaults from the documentDefaults in the constants file?

Can we make a parameter (and add it to the README.md) to allow someone to override the defaults when instantiating the html-to-docx library?

Last PR where I did this with the preprocessing flag although that was just doing true/false. Same idea though

https://github.com/TurboDocx/html-to-docx/pull/51/files

nicolasiscoding · 2024-10-05T17:47:53Z

.eslintrc.json

+      "js": "always",
+      "jsx": "always"
+    }],
+    "import/no-unresolved": "off",


remove this, we want to make sure everything is resolved

nicolasiscoding · 2024-10-05T17:49:11Z

src/helpers/xml-builder.js

@@ -854,7 +870,6 @@ const buildRun = async (vNode, attributes, docxDocumentInstance) => {
            case 'b':
              tempAttributes.strong = true;
              break;
-            case 'em':


why is this removed?

nicolasiscoding · 2024-10-05T17:50:07Z

src/helpers/xml-builder.js

-
-            paragraphFragment.import(runOrHyperlinkFragment);
-          }
+        if (childVNode.tagName === 'hr') {


note to self- test this in a few permutations

(Writing this second comment after seeing the other code on the bottom adding in the buildHorizontalRule)

Add test cases that distinguish between these two scenarios where we call buildHorizontalRule()

nicolasiscoding · 2024-10-05T17:54:38Z

src/helpers/xml-builder.js

@@ -2513,6 +2533,9 @@ const buildTableCell = async (vNode, attributes, rowSpanMap, columnIndex, docxDo
            }
          }
        }
+      } else if (isVNode(childVNode) && childVNode.tagName === 'hr') {


Can you add a test case around this in the example files

nicolasiscoding · 2024-10-05T17:58:58Z

src/helpers/render-document-file.js

@@ -19,6 +19,7 @@ import { vNodeHasChildren } from '../utils/vnode';
 import { isValidUrl } from '../utils/url';
 import { getMimeType } from '../utils/image';
 import { cloneDeep } from 'lodash';
+import { buildHorizontalRule } from '../helpers/xml-builder';


although I like this syntax better, for now to keep it consistent, follow the syntax of how the xmlBuilder is imported on line 15.

EG xmlBuilder.buildHorizontalRule in the code below

nicolasiscoding · 2024-10-05T17:59:14Z

src/helpers/render-document-file.js

@@ -309,6 +310,10 @@ async function findXMLEquivalent(docxDocumentInstance, vNode, xmlFragment) {
      const linebreakFragment = await xmlBuilder.buildParagraph(null, {});
      xmlFragment.import(linebreakFragment);
      return;
+    case 'hr':
+      const hrFragment = buildHorizontalRule();


See comment above

nicolasiscoding · 2024-10-05T18:01:45Z

Also - point this PR to merge to develop

Signed-off-by: Vishal <korada.vishal.phe22@itbhu.ac.in>

Vishalk91-4 · 2024-10-07T10:07:13Z

@nicolasiscoding
I have added the style thing
I will be adding the test cases

nicolasiscoding · 2024-10-07T11:41:09Z

src/helpers/xml-builder.js

@@ -179,6 +179,44 @@ const buildTableRowHeight = (tableRowHeight) =>
    .att('@w', 'hRule', 'atLeast')
    .up();

+const buildHorizontalRule = (element, styles = {}) => {


Follow the same design pattern as the other fragment builders, use the preprocessed styles outside of this and push it in.

Look at the params of the other fragment builders for reference and see how those values are being passed in

nicolasiscoding · 2024-10-09T11:35:18Z

src/html-to-docx.js

@@ -1,3 +1,4 @@
+// html-to-docx.js


Why is this added? Remove this

nicolasiscoding · 2024-10-10T01:23:00Z

src/helpers/xml-builder.js

@@ -470,11 +488,9 @@ const fixupColumnWidth = (columnWidthString, parentWidth = 0) => {
 const fixupMargin = (marginString) => {
  if (pointRegex.test(marginString)) {
    const matchedParts = marginString.match(pointRegex);
-    // convert point to half point


why are we removing comments?

nicolasiscoding · 2024-10-10T01:23:28Z

src/helpers/xml-builder.js

  }
 };

 const borderStyleParser = (style) => {
-  // Accepted OOXML Values for border style: http://officeopenxml.com/WPtableBorders.php


please do not remove comments? Is this all coming from AI which removes comments?

I don't know, when I pushed it wasn't like that
I'll change that

Signed-off-by: Vishal <korada.vishal.phe22@itbhu.ac.in>

nicolasiscoding · 2025-01-29T14:51:44Z

@Vishalk91-4 will you be finishing this? Otherwise will likely close this

Vishalk91-4 · 2025-01-29T15:04:20Z

You can close this, I have other commitments so I won't be handling this anytime sooner
Thanks

Added <hr> tag functionlity

3ecb7d4

Signed-off-by: Vishal <korada.vishal.phe22@itbhu.ac.in>

nicolasiscoding requested changes Oct 5, 2024

View reviewed changes

Added parameter and constants for hr styles

8a868ff

Signed-off-by: Vishal <korada.vishal.phe22@itbhu.ac.in>

Vishalk91-4 force-pushed the vishal/hr-tag branch from 44ae9fe to 8a868ff Compare October 6, 2024 13:48

Added style properties of hr rule

874210f

Signed-off-by: Vishal <korada.vishal.phe22@itbhu.ac.in>

Vishalk91-4 force-pushed the vishal/hr-tag branch from db8ea9f to 874210f Compare October 7, 2024 10:05

nicolasiscoding requested changes Oct 7, 2024

View reviewed changes

nicolasiscoding reviewed Oct 9, 2024

View reviewed changes

src/html-to-docx.js

@@ -1,3 +1,4 @@

// html-to-docx.js

Copy link

Member

nicolasiscoding Oct 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this added? Remove this

nicolasiscoding reviewed Oct 10, 2024

View reviewed changes

Added Parameters and style attributes

812e1ac

Signed-off-by: Vishal <korada.vishal.phe22@itbhu.ac.in>

Vishalk91-4 force-pushed the vishal/hr-tag branch from 627fb59 to 812e1ac Compare October 10, 2024 08:55

Fixed breaking changes of docx, making changes to buildhorizontalRule

b33bd80

Signed-off-by: Vishal <korada.vishal.phe22@itbhu.ac.in>

Vishalk91-4 force-pushed the vishal/hr-tag branch from d23afe1 to b33bd80 Compare October 10, 2024 08:56

Added fragments to fix height and border

29606e0

Signed-off-by: Vishal <korada.vishal.phe22@itbhu.ac.in>

Vishalk91-4 force-pushed the vishal/hr-tag branch from 393f625 to 29606e0 Compare October 12, 2024 03:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added <hr> tag functionlity #52

Added <hr> tag functionlity #52

Vishalk91-4 commented Oct 5, 2024

nicolasiscoding left a comment

nicolasiscoding Oct 5, 2024

nicolasiscoding Oct 5, 2024

nicolasiscoding Oct 5, 2024

nicolasiscoding Oct 5, 2024

nicolasiscoding Oct 5, 2024

nicolasiscoding Oct 5, 2024

nicolasiscoding Oct 5, 2024

nicolasiscoding Oct 5, 2024

nicolasiscoding Oct 5, 2024

nicolasiscoding commented Oct 5, 2024 •

edited

Loading

Vishalk91-4 commented Oct 7, 2024 •

edited

Loading

nicolasiscoding Oct 7, 2024

nicolasiscoding Oct 7, 2024

nicolasiscoding Oct 9, 2024

nicolasiscoding Oct 10, 2024

nicolasiscoding Oct 10, 2024

Vishalk91-4 Oct 10, 2024

nicolasiscoding commented Jan 29, 2025

Vishalk91-4 commented Jan 29, 2025 •

edited

Loading

Added <hr> tag functionlity #52

Are you sure you want to change the base?

Added <hr> tag functionlity #52

Conversation

Vishalk91-4 commented Oct 5, 2024

nicolasiscoding left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolasiscoding commented Oct 5, 2024 • edited Loading

Vishalk91-4 commented Oct 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolasiscoding commented Jan 29, 2025

Vishalk91-4 commented Jan 29, 2025 • edited Loading

nicolasiscoding commented Oct 5, 2024 •

edited

Loading

Vishalk91-4 commented Oct 7, 2024 •

edited

Loading

Vishalk91-4 commented Jan 29, 2025 •

edited

Loading