pwix:modal-info

What is it ?

This is a Bootstrap-based Meteor package which displays standard informations about an object:

maybe a name as a (centered) title
created at
created by
last updated at
last updated by
identifier

Configuration

None at the moment.

What does it provide ?

A global object

ModalInfo

Methods

`ModalInfo.i18n.namespace()`

Returns the i18n namespace of the package.

Blaze components

miButton

Just a button which will triggers the dialog opening with the attached object.

Known parameters are:

titleButton: the title attached to the button, defaulting to 'Informations about <name>'
classButton: the classes to be set on the button instead of the btn-sm btn-primary default
titleDialog: the title of the to-be-opened dialog, defaulting to 'Informations'
name: the name to be displayed at the top of the object informations, defaulting to nothing
object: (mandatory) the object to be displayed.

Please note that all the parameters will always be passed to the Modal.run() function, and then to the miPanel template. We are so able to add here as many pwix:modal parameters as you want.

miPanel

The display panel as an independant component. You are so able to integrate it into your own page.

Known parameters are:

name: the name to be displayed at the top of the object informations, defaulting to nothing
object: (mandatory) the object to be displayed.

Informations

Server-side

It could be useful to know that this package works by initializing a publication on Meteor.users collection for all records.

Only requested fields are:

username
emails
createdAt
createdBy
updatedAt
updatedBy

This is needed because we want display the email of the user responsible of the reaction (resp. the last update) of the displayed object.

NPM peer dependencies

Starting with v 1.1.0, and in accordance with advices from the Meteor Guide, we no more hardcode NPM dependencies in the Npm.depends clause of the package.js.

Instead we check npm versions of installed packages at runtime, on server startup, in development environment.

Dependencies as of v 1.4.0:

Each of these dependencies should be installed at application level:

    meteor npm install <package> --save

Translations

New and updated translations are willingly accepted, and more than welcome. Just be kind enough to submit a PR on the Github repository.

P. Wieser

Last updated on 2023, Oct. 11th