/ember-frost-object-browser

Primary LanguageJavaScriptMIT LicenseMIT

Travis Coveralls NPM

ember-frost-object-browser

Installation

ember install ember-frost-object-browser

API

Attribute Type Value Description
Coming soon

Examples

Template:

{frost-object-browser
  actionBarItems=actionBarItems
  facets=model.facets
  model=model.model
  actionBarItems=actionBarItems
  onCreate=(action "onCreate")
  onFacetChange=(action "onOptionSelected")
  onRowSelect=(action "onRowSelect")
  onActionClick=(action "onActionClick")
  title="Resources"
  values=model.visibleResources
  viewSchema=viewSchema
}}

Controller:

  actionBarItems: [
    {label: 'Details', id: 'details', enabled: false},
    {label: 'Delete', id: 'delete', enabled: false},
    {label: 'Edit', id: 'edit', enabled: false}
  ],
  viewSchema: {
    low: {
      'version': '1.0',
      'type': 'form',
      'rootContainers': [
        {'label': 'Main', 'container': 'main'}
      ],
      'containers': [
        {
          'id': 'main',
          'className': 'flex-row',
          'rows': [
            [
              {'model': 'alias', 'labelClassName': 'ob-label', 'inputClassName': 'ob-input'}
            ],
            [
              {
                'model': 'updatedAt',
                'label': 'Last Updated',
                'labelClassName': 'ob-label',
                'inputClassName': 'ob-input'
              }
            ]
          ]
        }
      ]
    }
  }

Your controller will also need to implement the following callbacks:

onCreate() onRowSelect(allSelected, newSelected, deSelected) onActionClick(actionId, currentSelection)

You can also check out the demo app bundled with this addon to see an example of using this addon.

Development

Setup

git clone git@github.com:ciena-frost/ember-frost-object-browser.git
cd ember-frost-object-browser
npm install && bower install

Development Server

A dummy application for development is available under ember-frost-object-browser/tests/dummy. To run the server run ember server (or npm start) from the root of the repository and visit the app at http://localhost:4200.

Testing

Run npm test from the root of the project to run linting checks as well as execute the test suite and output code coverage.