Coder Social home page Coder Social logo

simplewordwrapper's Introduction

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.

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

Option Type Default Description
separator string " " That option give you chance to select, what a symbol will be a separator to groups. The default value is space (" ").
parts number 2 That option need for select on how many groups you need to divide the selected text.
wrapperTag string "span" In this option you can determine tag name for wrapper.
wrapperClass string "simpleWordWrapper" In this option you can determine class name for wrapper.
eachWord boolean false If 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.
returnSeparator boolean/string true This 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.
lastSeparator boolean false This option adding an possibility to return separator for last item result.

simplewordwrapper's People

Contributors

bladeaweb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

hatteron

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.