# ish.js

> A tiny jQ'ish Javascript library.

Latest version **0.0.4** (published 2017-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install ish.js
pnpm add ish.js
yarn add ish.js
bun add ish.js
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2017-04-22 |
| First published | 2017-04-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Michael Hargreaves |
| Maintainers | mickatron |
| Keywords | javascript, browser, jQuery, library, ish, ish.js, ish-js |

## Links

- npm: https://www.npmjs.com/package/ish.js
- Repository: https://github.com/mickatron/ish.js
- Homepage: https://github.com/mickatron/ish.js#readme
- Issues: https://github.com/mickatron/ish.js/issues
- npm.io page: https://npm.io/package/ish.js

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2017-04-22
- 0.0.3 — 2017-04-07
- 0.0.2 — 2017-04-05
- 0.0.1 — 2017-04-05

## README

Ish.js(Alpha) is a super tiny Javascript library with a jQuery'ish syntax. [Visit the full documentation][docs].

## Distributed files

There's two compiled files available in the dist folder.

 -   `ish.lite.min.js` is around 3KB and includes only the ish.core.js and ish.events.js methods. Minified it weighs in just under 3KB.
 -   `ish.min.js` weighs in at around 9kb and incldes all Ish.js library methods.

### Compiling a custom version

See the 'Compiling a Custom Package Tutorial'.

## Browser Support

 -   IE9+
 -   Firefox
 -   Chrome
 -   Safari

## Mobile Support
TBA

## Installation & Quick Start

Install with Git, NPM or Yarn. 

    // Git
    $ git clone https://github.com/mickatron/ish.js.git
    // NPM
    $ npm i -D ish.js
    // Yarn
    $ yarn add ish.js --dev


Then include the 'dist/ish.min.js' file on your html page and you're ready to go.

    <script type="text/javascript" src="/path/to/ish.min.js">

## Core Methods

    // querySelectorAll based Selector Engine.
    ish('selector','context');
    
    // Selector Engine Utilities.
    ish('selector').nth();
    ish('selector').indexOf();
    ish('selector').forEach();
    
    // Basic Utils.
    ish('selector').attr();
    ish('selector').css();  
    ish('selector').offset();  
    ish('selector').dimension();
    
    // Event Methods.
    ish('selector').on();
    ish('selector').off();
    ish('selector').trigger();
    
    // Library Utils.
    ish.extends();

## Optional Methods
This is not a full list, please see the full [documentation][docs] for all availiable methods.

    // AJAX
    ish.ajax();
    
    // ish().dimension Abstracts
    ish('selector').width();
    ish('selector').height();
    
    // Classname Utils.
    ish('selector').hasClass();
    ish('selector').addClass();
    ish('selector').removeClass();
    
    //Responsive Util
    ish.responsive();
    //Routing
    ish.router();
    // Templating/rendering
    ish.renderTemplate()
    ish.updateTemplate()
    ish.renderBind()
    // State/Store
    ish.store
    



## Tutorials
 - [Getting Started][tut1]
 - [Compiling a custom Ish.js package][tut2]
 - (Coming soon) Using the Responsive Utility
 - (Coming soon) Using the Tween Utility

## Documentation
[Visit the full documentation][docs]

## Immediate To-dos;

 -  Error reporting.
 -  Improved Documentation and Theme   
 -  Improved testing
 -  review store/state component

 
 [docs]: http://ish.digitalfeast.com.au/js/docs
 [tut1]: http://ish.digitalfeast.com.au/js/docs/tutorial-Getting_Started.html
 [tut2]: http://ish.digitalfeast.com.au/js/docs/tutorial-Compiling_a_Custom_Package.html

---
_Source: https://npm.io/package/ish.js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._