# atom-pane

> A lightweight wrapper for creating new panes within Atom

Latest version **1.0.1** (published 2014-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install atom-pane
pnpm add atom-pane
yarn add atom-pane
bun add atom-pane
```

## 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.1 |
| Published | 2014-05-29 |
| First published | 2014-03-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Hugh Kennedy |
| Maintainers | hughsk |
| Keywords | atom, pane, editor, text, window, split, tab |

## Links

- npm: https://www.npmjs.com/package/atom-pane
- Repository: https://github.com/hughsk/atom-pane
- Issues: https://github.com/hughsk/atom-pane/issues
- npm.io page: https://npm.io/package/atom-pane

## Alternatives

- [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads
- [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads
- [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads
- [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads
- [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2014-05-29
- 1.0.0 — 2014-05-29
- 0.0.1 — 2014-03-03
- 0.0.0 — 2014-03-03

## README

# atom-pane [![Flattr this!](https://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=hughskennedy&url=http://github.com/hughsk/atom-pane&title=atom-pane&description=hughsk/atom-pane%20on%20GitHub&language=en_GB&tags=flattr,github,javascript&category=software)[![stable](http://hughsk.github.io/stability-badges/dist/stable.svg)](http://github.com/hughsk/stability-badges) #

A lightweight wrapper for creating new panes within [Atom](http://atom.io).

## Usage ##

[![atom-pane](https://nodei.co/npm/atom-pane.png?mini=true)](https://nodei.co/npm/atom-pane)

`atom-pane` is packaged as an npm module, so you can simply install it like
you would your other package dependencies.

### `uri = createPane([opts], ready, [closed])`

Create a new pane, calling `ready(err, pane)` when complete. The returned pane
is an instance of `ScrollView`, but you can easily append standard DOM elements
like so:

``` javascript
var createPane = require('atom-pane')

exports.activate = function() {
  atom.workspaceView.command('atom-plugin:open', function() {
    // create a div, any div
    var div = document.createElement('div')
    div.innerHTML = 'hello world!'
    div.style.color = '#fff'

    createPane(function(err, pane) {
      if (err) throw err
      // append the dive to your new pane
      pane.append(div)
    }, function() {
      div.parentNode.removeChild(div)
    })
  })
}
```

You'll need to clean up after yourself too – use the `closed` callback function,
which will get called when the pane has been closed.

Takes the following options:

* `opts.searchAllPanes` passed onto `atom.workspace.open`, defaults to `false`.
* `opts.uri` may be one of the following:
  * `undefined`, in which case a unique value will be genrated for you.
  * A unique string, e.g. `markdown-preview-pane`.
  * A full URI, e.g. `markdown-preview://Users/hughsk/README.md`.

  Note that the latter two approaches are recommended, to prevent creating
  a bunch of one-off openers each time a user opens a pane.
* `opts.changeFocus` passed onto `atom.workspace.open`, defaults to `true`.
* `opts.split` passed onto `atom.workspace.open`, defaults to `undefined`.


## License ##

MIT. See [LICENSE.md](http://github.com/hughsk/atom-pane/blob/master/LICENSE.md) for details.

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