Miss any of our Open RFC calls?Watch the recordings here! »

atom-bottom-dock

0.5.3 • Public • Published

atom-bottom-dock

atom-bottom-dock is an npm helper module that you can use to create panes for the bottom-dock atom package

API
class DockPaneView extends View {
  setActive(active: boolean): void
  isActive(): boolean
  getId(): string
  destroy(): void
}
class FilterSelector extends View {
  constructor(config?): void // where config is { filterLabel?: string, activeFilter?: string, filters?: [{ value: string, label?: string }]}
  updateFilters(config): void // where config is the same as constructor param
  setFilter(filterName: string): void
  getFilter(): string
  onDidChangeFilter(callback: Function): Disposable
  destroy(): void
}
class TableView extends View {
  constructor(data, columns): void // See [here](https://github.com/mleibman/SlickGrid) for information on how to structure data and columns
  deleteAllRows(): void
  addRows(rows): void
  onDidFinishAttaching(callback: Function): Disposable
  onDidClickGridItem(callback: Function): Disposable
  resize(heightOnly: boolean): void
class Toolbar extends View {
  addLeftTile(options): JQueryElement // where options is { item: JQueryElement, priority: int }
  addRightTile(options): JQueryElement // where options is { item: JQueryElement priority: int }
  destroy(): void
}

How to use

Extend the DockPaneView to create a new pane type for the bottom-dock package.

FilterSelector Example

{FilterSelector} = require 'atom-bottom-dock'
 
config =
  activeFilter: 'filter1'
  label: 'Example Filter:'
  filters: [{
    value: 'filter1'
  }{
    value: 'filter2'
    label: 'Filter2 Label'
  }]
 
filterSelector = new FilterSelector config
 
filterSelector.setActiveFilter 'filter2'
filterSelector.getActiveFilter() # 'filter2' 

TableView Example

{TableView} = require 'atom-bottom-dock'
 
 
columns = [
  {id: "type"name: "Type"field: "type"sortable: true }
  {id: "description"name: "Description"field: "description"sortable: true }
  {id: "path"name: "Path"field: "path"sortable: true }
  {id: "line"name: "Line"field: "line"sortable: true }
]
 
rows = [{
  type: "type"
  description: "description"
  path: "path"
  line: "line"
  message: "Some additional data to store with row (will not be displayed)"
}]
 
table = new TableView rowscolumns
 
table.addRows rows
 

Toolbar Example

{Toolbar} = require 'atom-bottom-dock'
toolbar = new Toolbar()
 
toolbar.addLeftTile item: $('button')priority: 0
toolbar.addRightTile item: $('<span>Example</span>')priority: 1

Keywords

none

Install

npm i atom-bottom-dock

DownloadsWeekly Downloads

23

Version

0.5.3

License

MIT

Last publish

Collaborators

  • avatar