Mui plugin

Integrate with the MUI framework

The plugin supports MUI v0.9.41.

Usage

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

<html>
    <head>
        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/muicss/0.9.41/css/mui.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="https://cdnjs.cloudflare.com/ajax/libs/muicss/0.9.41/js/mui.min.js"></script>
        <script src="/vendors/@form-validation/umd/bundle/popular.min.js"></script>
        <script src="/vendors/@form-validation/umd/plugin-mui/index.min.js"></script>
        <script>
            document.addEventListener('DOMContentLoaded', function(e) {
                FormValidation.formValidation(
                    document.getElementById('demoForm'),
                    {
                        fields: {
                            ...
                        },
                        plugins: {
                            mui: new FormValidation.plugins.Mui(),
                            ...
                        },
                    }
                );
            });
        </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 MUI.

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-mui

Import and use the Mui plugin:

import { formValidation } from '@form-validation/bundle/popular';
import { Mui } from '@form-validation/plugin-mui';

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

Stacked form

Multiple fields on the same row

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 Mui plugin will look for the .mui-row element. In the following example, the firstName and lastName fields are placed inside .mui-col-md-6 containers. Meanwhile, the city, state and zipcode fields can be found inside the .mui-col-md-4 containers.

The rowSelector option will be used to help the plugin determine the field containers as following:

mui: new FormValidation.plugins.Mui({
    rowSelector: function(field, ele) {
        // field is the field name
        // ele is the field element
        switch (field) {
            case 'firstName':
            case 'lastName':
                return '.mui-col-md-6';

            case 'city':
            case 'state':
            case 'zipcode':
                return '.mui-col-md-4';

            default:
                return '.mui-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 Mui plugin requires FormValidation v1.2.0 or newer.

Mini plugin PasswordStrength plugin