1.1.0 • Published 6 years ago

simplewordwrapper v1.1.0

Weekly downloads
4
License
MIT
Repository
github
Last release
6 years ago

simpleWordWrapper by Alexander Sharkov

v.1.1.0

What is it?

It's a little jQuery module developed to help for website developers, when they need to wrap each word or divided the words to some groups. For example in menu, when you need divided link's text in two group but you couldn't do this in back-end of your CMS.

What's new:

  • Added new option for return or not, or changing separator for result items.
  • Added option for adding separator for last result item.

Demo

1.Getting Started

  • Download source or clone repository
If you use Bower
    bower install simpleWordWrapper -save
If you use NPM
    npm install simplewordwrapper
  • Load jQuery(1.7+)
  • Include source files simpleWordWrapper.min.js or simpleWordWrapper.js of simpleWordWrapper into your project
  • And read this manual to start work the script in your project.
Html before close body
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="your path/simpleWordWrapper.min.js"></script>

2.Call the plugin

Now call the simpleWordWrapper initialize function for your selector and after that you could see that text in your selector wrapped.

JavaScript default call
$("#some-id").simpleWordWrapper();
JavaScript call with options (in this case I show you what is default values for options)
$("#some-id").simpleWordWrapper({
    separator: " ",
    parts: 2,
    wrapperTag: "span",
    wrapperClass: "simpleWordWrapper",
    eachWord: false,
    returnSeparator: true,
    lastSeparator: false
});

3.Options list

OptionTypeDefaultDescription
separatorstring" "That option give you chance to select, what a symbol will be a separator to groups. The default value is space (" ").
partsnumber2That option need for select on how many groups you need to divide the selected text.
wrapperTagstring"span"In this option you can determine tag name for wrapper.
wrapperClassstring"simpleWordWrapper"In this option you can determine class name for wrapper.
eachWordbooleanfalseIf you change value this option from false to true you disabled option parts, and each words or group of words, divided separator, will wrap in a wrapperTag with a wrapperClass.
returnSeparatorboolean/stringtrueThis option adding an possibility to change result items separator returning. Should be Boolean or String. If you set it as string to end of each result item will have been adding your value.
lastSeparatorbooleanfalseThis option adding an possibility to return separator for last item result.