AutoSuggest: Better way to implement focus after inserting a snippet












0












$begingroup$


Introduction:



I am working on a javascript plugin AutoSuggest, My aim is to create an IDE like autocomplete experience in web applications using JavaScript.



One of the features I have implemented is focusing a particular portion of inserted snippet after insertion. This is how I am asking input for focus.




focusText: [StartIndex, EndIndex]



StartIndex and EndIndex of the content that should be in focus
after inserting the text. As of now these indexes should be calculated
as (0 - numberOfCharactersFromEnd)



focusHtml: [StartIndex, EndIndex]



StartIndex and EndIndex of the content that should be in focus after inserting the HTML. As of now these indexes should be calculated as (0 - numberOfCharactersFromEnd). This should not include the characters from HTML tags




Example:



{
value: 'script',
insertText: '<script type="text/javascript" src="path/to/jsfile"></script>',
focusText: [-25, -11],
insertHtml: `&lt;<span style="color: red">script</span>&nbsp;<span style="color:green">type</span>=<span style="color:darksalmon">"text/javascript"</span>&nbsp;<span style="color:green">src</span>=<span style="color:darksalmon">"path/to/jsfile"</span>&gt;&lt;/<span style="color: red">script</span>&gt;`,
focusHtml: [-25, -11],
}

// Should focus `path/to/jsfile` after inserting the snippet


insertText and focusText are for inserting snippet as text.



insertHtml and focusHtml are for inserting snippet as html elements.



And I am evaluating the focus value as follows:



/* For inserting as text:
* textNode is the text node in which the snippet has been inserted
* selection is the range object of current selection.
* cursorPosition is after the last character in inserted snippet
* */

selection.setStart(textNode, cursorPosition + focusText[0]);
selection.setEnd(textNode, cursorPosition + focusText[1]);


/* For inserting as HTML:
* textNode is the text node after which the new html element(s) will be inserted
* selection is the range object of current selection.
* insertHtmlAfter returns an Array of newly inserted nodes
* */
const nodes = insertHtmlAfter(textNode, suggestion.insertHtml);
const focus = nodes.length ? suggestion.focusHtml : [0, 0];
function setSelection(focus, nodes, method) {
let lastNode, lastFocus = focus;
if (lastFocus !== 0) {
do {
lastNode = nodes.pop();
lastFocus += lastNode.textContent.length;
} while(nodes.length && lastFocus < 0);

if (!lastNode) {
throw new TypeError(`AutoSuggest: Invalid value provided for Suggestion.focusHtml`);
};
}

if (lastFocus === 0) {
selection[method + 'After'](nodes[nodes.length - 1] || startContainer);
} else {
if (lastNode.nodeType === lastNode.TEXT_NODE) {
selection[method](lastNode, lastFocus);
} else {
setSelection(
lastFocus - lastNode.textContent.length,
Array.from(lastNode.childNodes),
method
);
}
}
};

setSelection(focus[1], [...nodes], 'setEnd');
setSelection(focus[0], [...nodes], 'setStart');


Problem:




  1. Asking for focus values as negative numbers might be confusing for the users, but it simplifies the logic for focusText, so is there any better way that is both user friendly and requires simpler logic.


  2. I think the logic for setting the focus for inserting as HTML is a bit over-complicated, is there any better way to achieve this?











share|improve this question







New contributor




AvcS is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.







$endgroup$

















    0












    $begingroup$


    Introduction:



    I am working on a javascript plugin AutoSuggest, My aim is to create an IDE like autocomplete experience in web applications using JavaScript.



    One of the features I have implemented is focusing a particular portion of inserted snippet after insertion. This is how I am asking input for focus.




    focusText: [StartIndex, EndIndex]



    StartIndex and EndIndex of the content that should be in focus
    after inserting the text. As of now these indexes should be calculated
    as (0 - numberOfCharactersFromEnd)



    focusHtml: [StartIndex, EndIndex]



    StartIndex and EndIndex of the content that should be in focus after inserting the HTML. As of now these indexes should be calculated as (0 - numberOfCharactersFromEnd). This should not include the characters from HTML tags




    Example:



    {
    value: 'script',
    insertText: '<script type="text/javascript" src="path/to/jsfile"></script>',
    focusText: [-25, -11],
    insertHtml: `&lt;<span style="color: red">script</span>&nbsp;<span style="color:green">type</span>=<span style="color:darksalmon">"text/javascript"</span>&nbsp;<span style="color:green">src</span>=<span style="color:darksalmon">"path/to/jsfile"</span>&gt;&lt;/<span style="color: red">script</span>&gt;`,
    focusHtml: [-25, -11],
    }

    // Should focus `path/to/jsfile` after inserting the snippet


    insertText and focusText are for inserting snippet as text.



    insertHtml and focusHtml are for inserting snippet as html elements.



    And I am evaluating the focus value as follows:



    /* For inserting as text:
    * textNode is the text node in which the snippet has been inserted
    * selection is the range object of current selection.
    * cursorPosition is after the last character in inserted snippet
    * */

    selection.setStart(textNode, cursorPosition + focusText[0]);
    selection.setEnd(textNode, cursorPosition + focusText[1]);


    /* For inserting as HTML:
    * textNode is the text node after which the new html element(s) will be inserted
    * selection is the range object of current selection.
    * insertHtmlAfter returns an Array of newly inserted nodes
    * */
    const nodes = insertHtmlAfter(textNode, suggestion.insertHtml);
    const focus = nodes.length ? suggestion.focusHtml : [0, 0];
    function setSelection(focus, nodes, method) {
    let lastNode, lastFocus = focus;
    if (lastFocus !== 0) {
    do {
    lastNode = nodes.pop();
    lastFocus += lastNode.textContent.length;
    } while(nodes.length && lastFocus < 0);

    if (!lastNode) {
    throw new TypeError(`AutoSuggest: Invalid value provided for Suggestion.focusHtml`);
    };
    }

    if (lastFocus === 0) {
    selection[method + 'After'](nodes[nodes.length - 1] || startContainer);
    } else {
    if (lastNode.nodeType === lastNode.TEXT_NODE) {
    selection[method](lastNode, lastFocus);
    } else {
    setSelection(
    lastFocus - lastNode.textContent.length,
    Array.from(lastNode.childNodes),
    method
    );
    }
    }
    };

    setSelection(focus[1], [...nodes], 'setEnd');
    setSelection(focus[0], [...nodes], 'setStart');


    Problem:




    1. Asking for focus values as negative numbers might be confusing for the users, but it simplifies the logic for focusText, so is there any better way that is both user friendly and requires simpler logic.


    2. I think the logic for setting the focus for inserting as HTML is a bit over-complicated, is there any better way to achieve this?











    share|improve this question







    New contributor




    AvcS is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
    Check out our Code of Conduct.







    $endgroup$















      0












      0








      0





      $begingroup$


      Introduction:



      I am working on a javascript plugin AutoSuggest, My aim is to create an IDE like autocomplete experience in web applications using JavaScript.



      One of the features I have implemented is focusing a particular portion of inserted snippet after insertion. This is how I am asking input for focus.




      focusText: [StartIndex, EndIndex]



      StartIndex and EndIndex of the content that should be in focus
      after inserting the text. As of now these indexes should be calculated
      as (0 - numberOfCharactersFromEnd)



      focusHtml: [StartIndex, EndIndex]



      StartIndex and EndIndex of the content that should be in focus after inserting the HTML. As of now these indexes should be calculated as (0 - numberOfCharactersFromEnd). This should not include the characters from HTML tags




      Example:



      {
      value: 'script',
      insertText: '<script type="text/javascript" src="path/to/jsfile"></script>',
      focusText: [-25, -11],
      insertHtml: `&lt;<span style="color: red">script</span>&nbsp;<span style="color:green">type</span>=<span style="color:darksalmon">"text/javascript"</span>&nbsp;<span style="color:green">src</span>=<span style="color:darksalmon">"path/to/jsfile"</span>&gt;&lt;/<span style="color: red">script</span>&gt;`,
      focusHtml: [-25, -11],
      }

      // Should focus `path/to/jsfile` after inserting the snippet


      insertText and focusText are for inserting snippet as text.



      insertHtml and focusHtml are for inserting snippet as html elements.



      And I am evaluating the focus value as follows:



      /* For inserting as text:
      * textNode is the text node in which the snippet has been inserted
      * selection is the range object of current selection.
      * cursorPosition is after the last character in inserted snippet
      * */

      selection.setStart(textNode, cursorPosition + focusText[0]);
      selection.setEnd(textNode, cursorPosition + focusText[1]);


      /* For inserting as HTML:
      * textNode is the text node after which the new html element(s) will be inserted
      * selection is the range object of current selection.
      * insertHtmlAfter returns an Array of newly inserted nodes
      * */
      const nodes = insertHtmlAfter(textNode, suggestion.insertHtml);
      const focus = nodes.length ? suggestion.focusHtml : [0, 0];
      function setSelection(focus, nodes, method) {
      let lastNode, lastFocus = focus;
      if (lastFocus !== 0) {
      do {
      lastNode = nodes.pop();
      lastFocus += lastNode.textContent.length;
      } while(nodes.length && lastFocus < 0);

      if (!lastNode) {
      throw new TypeError(`AutoSuggest: Invalid value provided for Suggestion.focusHtml`);
      };
      }

      if (lastFocus === 0) {
      selection[method + 'After'](nodes[nodes.length - 1] || startContainer);
      } else {
      if (lastNode.nodeType === lastNode.TEXT_NODE) {
      selection[method](lastNode, lastFocus);
      } else {
      setSelection(
      lastFocus - lastNode.textContent.length,
      Array.from(lastNode.childNodes),
      method
      );
      }
      }
      };

      setSelection(focus[1], [...nodes], 'setEnd');
      setSelection(focus[0], [...nodes], 'setStart');


      Problem:




      1. Asking for focus values as negative numbers might be confusing for the users, but it simplifies the logic for focusText, so is there any better way that is both user friendly and requires simpler logic.


      2. I think the logic for setting the focus for inserting as HTML is a bit over-complicated, is there any better way to achieve this?











      share|improve this question







      New contributor




      AvcS is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.







      $endgroup$




      Introduction:



      I am working on a javascript plugin AutoSuggest, My aim is to create an IDE like autocomplete experience in web applications using JavaScript.



      One of the features I have implemented is focusing a particular portion of inserted snippet after insertion. This is how I am asking input for focus.




      focusText: [StartIndex, EndIndex]



      StartIndex and EndIndex of the content that should be in focus
      after inserting the text. As of now these indexes should be calculated
      as (0 - numberOfCharactersFromEnd)



      focusHtml: [StartIndex, EndIndex]



      StartIndex and EndIndex of the content that should be in focus after inserting the HTML. As of now these indexes should be calculated as (0 - numberOfCharactersFromEnd). This should not include the characters from HTML tags




      Example:



      {
      value: 'script',
      insertText: '<script type="text/javascript" src="path/to/jsfile"></script>',
      focusText: [-25, -11],
      insertHtml: `&lt;<span style="color: red">script</span>&nbsp;<span style="color:green">type</span>=<span style="color:darksalmon">"text/javascript"</span>&nbsp;<span style="color:green">src</span>=<span style="color:darksalmon">"path/to/jsfile"</span>&gt;&lt;/<span style="color: red">script</span>&gt;`,
      focusHtml: [-25, -11],
      }

      // Should focus `path/to/jsfile` after inserting the snippet


      insertText and focusText are for inserting snippet as text.



      insertHtml and focusHtml are for inserting snippet as html elements.



      And I am evaluating the focus value as follows:



      /* For inserting as text:
      * textNode is the text node in which the snippet has been inserted
      * selection is the range object of current selection.
      * cursorPosition is after the last character in inserted snippet
      * */

      selection.setStart(textNode, cursorPosition + focusText[0]);
      selection.setEnd(textNode, cursorPosition + focusText[1]);


      /* For inserting as HTML:
      * textNode is the text node after which the new html element(s) will be inserted
      * selection is the range object of current selection.
      * insertHtmlAfter returns an Array of newly inserted nodes
      * */
      const nodes = insertHtmlAfter(textNode, suggestion.insertHtml);
      const focus = nodes.length ? suggestion.focusHtml : [0, 0];
      function setSelection(focus, nodes, method) {
      let lastNode, lastFocus = focus;
      if (lastFocus !== 0) {
      do {
      lastNode = nodes.pop();
      lastFocus += lastNode.textContent.length;
      } while(nodes.length && lastFocus < 0);

      if (!lastNode) {
      throw new TypeError(`AutoSuggest: Invalid value provided for Suggestion.focusHtml`);
      };
      }

      if (lastFocus === 0) {
      selection[method + 'After'](nodes[nodes.length - 1] || startContainer);
      } else {
      if (lastNode.nodeType === lastNode.TEXT_NODE) {
      selection[method](lastNode, lastFocus);
      } else {
      setSelection(
      lastFocus - lastNode.textContent.length,
      Array.from(lastNode.childNodes),
      method
      );
      }
      }
      };

      setSelection(focus[1], [...nodes], 'setEnd');
      setSelection(focus[0], [...nodes], 'setStart');


      Problem:




      1. Asking for focus values as negative numbers might be confusing for the users, but it simplifies the logic for focusText, so is there any better way that is both user friendly and requires simpler logic.


      2. I think the logic for setting the focus for inserting as HTML is a bit over-complicated, is there any better way to achieve this?








      javascript dom text-editor






      share|improve this question







      New contributor




      AvcS is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.











      share|improve this question







      New contributor




      AvcS is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.









      share|improve this question




      share|improve this question






      New contributor




      AvcS is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.









      asked 22 mins ago









      AvcSAvcS

      1011




      1011




      New contributor




      AvcS is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.





      New contributor





      AvcS is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.






      AvcS is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.






















          0






          active

          oldest

          votes











          Your Answer





          StackExchange.ifUsing("editor", function () {
          return StackExchange.using("mathjaxEditing", function () {
          StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix) {
          StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
          });
          });
          }, "mathjax-editing");

          StackExchange.ifUsing("editor", function () {
          StackExchange.using("externalEditor", function () {
          StackExchange.using("snippets", function () {
          StackExchange.snippets.init();
          });
          });
          }, "code-snippets");

          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "196"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: false,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: null,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });






          AvcS is a new contributor. Be nice, and check out our Code of Conduct.










          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f216138%2fautosuggest-better-way-to-implement-focus-after-inserting-a-snippet%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown

























          0






          active

          oldest

          votes








          0






          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes








          AvcS is a new contributor. Be nice, and check out our Code of Conduct.










          draft saved

          draft discarded


















          AvcS is a new contributor. Be nice, and check out our Code of Conduct.













          AvcS is a new contributor. Be nice, and check out our Code of Conduct.












          AvcS is a new contributor. Be nice, and check out our Code of Conduct.
















          Thanks for contributing an answer to Code Review Stack Exchange!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          Use MathJax to format equations. MathJax reference.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f216138%2fautosuggest-better-way-to-implement-focus-after-inserting-a-snippet%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          Сан-Квентин

          8-я гвардейская общевойсковая армия

          Алькесар