# jquery-iframe-ajax

> jQuery IFrame AJAX Transport (emulation upload files via AJAX)

Latest version **1.0.3** (published 2021-05-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install jquery-iframe-ajax
pnpm add jquery-iframe-ajax
yarn add jquery-iframe-ajax
bun add jquery-iframe-ajax
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-05-22 |
| First published | 2016-06-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 27.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | paulzi |
| Keywords | iframe, ajax, jquery |

## Links

- npm: https://www.npmjs.com/package/jquery-iframe-ajax
- Repository: https://github.com/paulzi/jquery-iframe-ajax
- Homepage: https://github.com/paulzi/jquery-iframe-ajax#readme
- Issues: https://github.com/paulzi/jquery-iframe-ajax/issues
- npm.io page: https://npm.io/package/jquery-iframe-ajax

## Dependencies (1)

- [jquery](https://npm.io/package/jquery.md) >=1.7.0

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-05-22
- 1.0.2 — 2016-12-05
- 1.0.1 — 2016-06-14
- 1.0.0 — 2016-06-07

## README

# jQuery IFrame AJAX

[![NPM version](http://img.shields.io/npm/v/jquery-iframe-ajax.svg?style=flat)](https://www.npmjs.org/package/jquery-iframe-ajax)
![Bower version](http://img.shields.io/bower/v/jquery-iframe-ajax.svg?style=flat)

Library provides transport to emulate AJAX via hidden iframe. In the first place necessary for AJAX uploading files to older browsers do not support the XMLHttpRequest 2.

Demo: http://paulzi.ru/jquery-iframe-ajax/

[Russian readme](https://github.com/paulzi/jquery-iframe-ajax/blob/master/README.ru.md)

## Install

Install via NPM
```sh
npm install jquery-iframe-ajax
```

Install via Bower
```sh
bower install jquery-iframe-ajax
```

Or install manually.

## Usage

Include library on page after jQuery:

```html
<script src="/bower_components/jquery/dist/jquery.min.js">
<script src="/bower_components/jquery-iframe-ajax/dist/jquery-iframe-ajax.min.js">
```

Now you can upload files via iframe transport:

```js
$(document).on('click', function () {
    $.ajax({
        url:    '/path/to/handler',
        method: 'post',
        iframe: true,
        data:   { additional: 'value' },
        files:  $('.form input[type="file"]')
    })
        .done(function (data) {
            alert(data);
        });
});
```

You can also send the existing form with all files and fields:

```js
$(document).on('click', function () {
    $.ajax({
        url:    '/path/to/handler',
        method: 'post',
        iframe: true,
        data:   { additional: 'value' },
        form:   $('.form')
    })
        .done(function (data) {
            alert(data);
        });
});
```

## Options

- `iframe` - enable iframe transport
- `files` - array of `input[type="file"]` or jQuery object with similar elements (using if `form` option is not set)
- `form` - form or jQuery object with form (option `files` will be ignored)
- `iframeOnSubmit` - callback after iframe form submit

## Response handling

By default, the iframe does not provide information about the response, such as:

- HTTP code
- HTTP status text
- Content-Type of response
- Headers

But you can emulate this support by wrapping the content in the tag `<textarea>`:
```html
<textarea data-status="403" data-status-text="Forbidden" data-content-type="text/json">
{"status": "Auth required"}
</textarea>
```

List of `textarea` attributes:

- `data-status` *(int)* - **(required)** HTTP code of response
- `data-status-text` *(string)* - HTTP response short description (see: HTTP Reason-Phrase)
- `data-content-type` *(string)* - Content-Type of response (it is override value in headers)
- `data-headers` *(plain object or string)* - List of header
 
**Note**: the real response code for iframe must be 200 for the correct processing of the contents `textarea`.

## Detect IFrame transport

If the request was sent via IFrame, then further transferred POST parameter `X-Requested-With = IFrame` (that param, not header!).

That way you can have different responding depending on transport:

```php
$response = json_encode(['status' => 'ok']);
if (!empty($_POST['X-Requested-With']) && $_POST['X-Requested-With'] === 'IFrame') {
    echo "<textarea data-status="200" data-status-text="OK" data-content-type="text/json">{$content}</textarea>";
} else {
    header("Content-Type: text/json");
    echo $content;
}
```

## Requirements

- jQuery 1.7+

## Browser support

Tested with browsers:

- Internet Explorer 7+
- Chrome 7+
- Firefox 3+
- Opera 15+
- Safari 5+
- Android Browser 2.2+
- iOS Safari ?

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