Nuanced Pterodactyl Monk

    angular-otobox

    0.2.0 • Public • Published

    angular-otobox

    Angular directive for highlighting text parts, a replacement to all mentioning libraries. Written on plain Javascript with no dependency.

    This Angular module is written based on otobox.js from Afshin Mehrabani

    Install

    Bower

    bower install angular-otobox

    How to use

    • Add scripts to the layout file:
      <script src="path/to/otobox.js">
      <script src="path/to/angular-otobox.js">

    • Add module to dependency list

    var app = angular.module('yourApp',[
      "angular-otobox",
    ]);
    • Define settings

    It's possible to define as much activators as needed:

    app.directive('otoboxConfig', function () {
      return {
        controller: function ($scope) {
     
          this.getConfig = function () {
              return {
                key: $attrs.otoboxConfig,
                activators: [
     
                  {
                    name: "mention.array",
                    key: "@",
                    customChoice: "false",
                    includeKey: "true",
                    allowedChars: "[a-zA-Z0-9]+",
                    source: "/path/to/users"
                  },
                  {
                    name: "mention.array",
                    key: "#",
                    customChoice: "true",
                    includeKey: "true",
                    allowedChars: "[a-zA-Z0-9]+",
                    source: "/path/to/tags"
                  }
     
                ]
              }
            }
     
        }
      }
    });
     

    then add direcives to textarea element

    <textarea
      otobox-config="otobox"
      otobox="item">
    </textarea>

    which $scope.item is the object that you want the otobox object to be appended to. the otobox value passed to otoboxConfig directive is the name of otobox object while pinning to $scope.item.

    If there is only one activator for each element, it's possible to define configs as element attributes too:

     
    <textarea
        otobox="mention.array"
        otobox-key="@"
        otobox-custom-choice="true"
        otobox-include-key="true"
        otobox-allowed-chars="[a-zA-Z0-9]+"
        otobox-source="/path/to/users">
      </textarea>

    Roadmap

    • Caching prevoiusly loaded names

    Release History

    Author

    Ali Haghighatkhah

    Special thanks to Afshin Mehrabani

    License

    Copyright (C) 2015 Ali Haghighatkhah (alihaghighatkhah@yahoo.com)

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Keywords

    none

    Install

    npm i angular-otobox

    DownloadsWeekly Downloads

    3

    Version

    0.2.0

    License

    MIT

    Last publish

    Collaborators

    • jdcrensh