ember-frost-about-dialog
v4.0.1
Published
Simple about dialog for Ember apps.
Downloads
19
Readme
ember-frost-about-dialog
A simple 'About' modal dialog using ember-remodal
Installation
ember install ember-frost-about-dialog
API
| Attribute | Type | Value | Description |
| --------- | ---- | ----- | ----------- |
| modalName
| string
| | Required name of the about modal |
| title
| string
| | Name of product |
| message
| string
| | Product tag line for about dialog |
| serverMessage
| array
| | Array of strings - Message from the server |
| copyrightText
| array
| | Array of Copyright text string where array items are separated by line breaks |
| logoPath
| string
| | Path to logo svg |
| stripPath
| string
| | Path to branding strip svg |
| licenseText
| array
| | Array of license text string where array items are separated by line breaks |
| target
| block-slot
| | Block-slot template to yield the element that will launch the dialog on click |
Examples
{{#frost-about-dialog
title='Product Name'
message='Product tag line bacon ipsum color ametr turducken tial'
serverMessage=dialogServerMessage
licenseText=dialogLicenseText
copyrightText='Copyright © 2016 Company, all rights reserved.'
logoPath='app/company'
stripPath='app/company-strip'
modalName=modalName
}}
{{#block-slot slot 'target'}}
{{frost-button
priority='primary'
size='medium'
text='Launch About Dialog'
}}
{{/block-slot}}
{{/frost-about-dialog}}
Development
Setup
git clone [email protected]:ciena-frost/ember-frost-about-dialog.git
cd ember-frost-about-dialog
npm install && bower install
Development Server
A dummy application for development is available under ember-frost-about-dialog/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.