Milligram plugin

Integrate with the Milligram framework

The plugin supports Milligram v1.3.0.

Usage

The following piece of code is the starting point to validate the form made in Milligram:

<html>
    <head>
        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/milligram/1.3.0/milligram.min.css" />
        <link rel="stylesheet" href="/vendors/@form-validation/umd/styles/index.min.css" />
    </head>
    <body>
        <form id="demoForm" method="POST">...</form>

        <script src="https://cdnjs.cloudflare.com/ajax/libs/es6-shim/0.35.3/es6-shim.min.js"></script>
        <script src="/vendors/@form-validation/umd/bundle/popular.min.js"></script>
        <script src="/vendors/@form-validation/umd/plugin-milligram/index.min.js"></script>
        <script>
            document.addEventListener('DOMContentLoaded', function(e) {
                FormValidation.formValidation(
                    document.getElementById('demoForm'),
                    {
                        fields: {
                            ...
                        },
                        plugins: {
                            milligram: new FormValidation.plugins.Milligram(),
                            ...
                        },
                    }
                );
            });
        </script>
    </body>
</html>

The sample code above assumes that the FormValidation files are placed inside the vendors directory. You might need to change the path depending on where you place them on the server.

The next sections list out some examples of various forms made with Milligram.

Using the npm packages

If you are using a bundler such as Webpack, Rollup, Parcel or Vite, etc., to bundle your application, then it's recommended to use the FormValidation NPM packages.

Install the packages:

$ npm install @form-validation/bundle
$ npm install @form-validation/plugin-milligram

Import and use the Milligram plugin:

import { formValidation } from '@form-validation/bundle/popular';
import { Milligram } from '@form-validation/plugin-milligram';

formValidation(
    document.getElementById('demoForm'),
    {
        fields: {
            ...
        },
        plugins: {
            milligram: new Milligram({
                ...
            }),
            ...
        },
    }
);

Horizontal form

Stacked form

You need to add the fv-stacked-form class to the form element such as:

<form class="fv-stacked-form">
    <!-- The fields go here -->
    ...
</form>

In order to add the correct class for error message and the field element when it is a valid or invalid, we need to specify the CSS selector of the field container.

By default, the Milligram plugin will look for the .row element. But in the stacked form below, every field will be placed inside our own .fv-row container.

We need to use the rowSelector option to help the plugin determine the field containers as following:

milligram: new FormValidation.plugins.Milligram({
    rowSelector: function(field, ele) {
        // field is the field name
        // ele is the field element
        return '.fv-row';
    }

    // Or you can just simply pass it as a string:
    // rowSelector: '.fv-row',
}),

Stacked form

Multiple fields on the same row

In the following example, the firstName and lastName fields are placed inside .column-25 containers. Meanwhile, the city, state and zipcode fields can be found inside the .column-20 containers.

Again, we need to use the rowSelector option:

milligram: new FormValidation.plugins.Milligram({
    rowSelector: function(field, ele) {
        // field is the field name
        // ele is the field element
        switch (field) {
            case 'firstName':
            case 'lastName':
                return '.column-25';

            case 'city':
            case 'state':
            case 'zipcode':
                return '.column-20';

            default:
                return '.row';
        }
    }
}),

Multiple fields on the same row

Changelog

v2.4.0

The plugin can be enabled or disabled using the enablePlugin and disablePlugin methods

v2.0.0

Add the npm package

v1.2.0

First release. It means that the Milligram plugin requires FormValidation v1.2.0 or newer.

Message plugin Mini plugin