abernix / semantic-ui-modal Goto Github PK

#semantic-ui-modal

A package for creating Semantic Modals, designed to play nice with Meteor.

NOTE: THIS WILL ALSO ADD THE ENTIRE SEMANTIC-UI PACKAGE, WHICH IS PRETTY CHUNKY! I might release a future version with only the relevant css and js for the modal, but for the time being, this is designed for people who are using Semantic-UI for the rest of their app.

Allows the user to create Semantic-UI modals on the fly from Javascript code. For example:

SemanticModal.confirmModal(
    {
        header: "Example Modal",
        message: "Click a button, please.",
        callback: function() {
            console.log("You clicked okay!");    
        }
    }, function() {
        console.log("The modal has just been shown");
    }
);

Tested on Meteor 0.8.3, and the general modal method relies on {{>UI.dynamic ...}}, so it will not work with versions earlier than 0.8.2. Confirm modal may work on earlier versions, but it's untested.

meteor add richsilv:semantic-ui-modal

The package will add an object called SemanticModal to the global namespace. It has two methods:

This will render a simple modal with header, body and either "Okay" and "Cancel" buttons, or no buttons at all. It is designed as a convenience method.

options - an object containing any of the following:

• header: string header
• message: the main body of the modal, which can be HTML or a simple string.
• noButtons: if set to true, the modal will have no button row, and must be closed by clicking on the dimmer.
• callback: a function to run when the user clicks the "Okay" button. The function is passed a single argument containing the options object, allowing the user to add further properties to be used in the callback to this object as required. Within the callback, this refers to the modal node in the DOM.

Note that if the modal is closed by clicking "Cancel", no further action will be taken.

postRender - a callback to run once the modal has been shown. As above, one argument, containing options, is passed to this function, whilst this refers to the DOMRange containing the modal. If anybody has any idea how I can return the template instance itself instead of the DOMRange, let me know!

This will render the supplied template in a new modal, with the data context provided. Note that although the template will be reactive with respect to any registered helpers, it will not be reactive with respect to the data context. This is a consequence of the way UI.renderWithData works at present.

template - the string name of any registered template (note that you cannot pass the template instance constructor itself).

data - the data context to pass to the rendered template. Note that at present this is NOT reactive, so if reactivity is required in any part of the template, you need to register an appropriate helper for the supplied template. These will work in the same way they would anywhere else.

options - an object containing any of the following:

• modalSettings: a dictionary of Semantic-UI modal settings which will overwrite the defaults.
• modalClass: CSS class(es) to be added to the "ui modal" object. This allows for easy styling of the modal with user stylesheets, particularly as far as width and horizontal positioning are concerned. Semantic-UI already ships with the modal classes small and large for overwriting the default width settings, but custom width classes are easy to write by simply specifying width and negative margin-left of half the width.
• postRender: a function to run once the modal has been shown. The details are exactly as above.

Events should be handled by registering handlers using the usual Template.xxx.events API for the template that's going to be passed to the generalModal method.

There is a demo running at semantic-ui-modal-demo.meteor.com, with the source available here.

Please feel free to raise an issue if you encounter problems or you'd like to suggest a feature.