Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/DavyJonesLocker/client_side_validations-simple_form

Simple Form plugin for ClientSideValidations
https://github.com/DavyJonesLocker/client_side_validations-simple_form

clientsidevalidations rails simpleform

Last synced: 6 days ago
JSON representation

Simple Form plugin for ClientSideValidations

Host: GitHub
URL: https://github.com/DavyJonesLocker/client_side_validations-simple_form
Owner: DavyJonesLocker
License: mit
Created: 2011-10-08T06:59:18.000Z (about 13 years ago)
Default Branch: main
Last Pushed: 2024-05-03T17:41:56.000Z (6 months ago)
Last Synced: 2024-05-23T05:32:29.302Z (6 months ago)
Topics: clientsidevalidations, rails, simpleform
Language: JavaScript
Homepage:
Size: 589 KB
Stars: 252
Watchers: 7
Forks: 102
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # ClientSideValidations-SimpleForm #

[![Gem Version](https://badge.fury.io/rb/client_side_validations-simple_form.svg)](https://badge.fury.io/rb/client_side_validations-simple_form)

[![npm version](https://badge.fury.io/js/%40client-side-validations%2Fsimple-form.svg)](https://badge.fury.io/js/%40client-side-validations%2Fsimple-form)

[![Ruby Build Status](https://github.com/DavyJonesLocker/client_side_validations-simple_form/actions/workflows/ruby.yml/badge.svg)](https://github.com/DavyJonesLocker/client_side_validations-simple_form/actions)

[![JavaScript Build Status](https://github.com/DavyJonesLocker/client_side_validations-simple_form/actions/workflows/javascript.yml/badge.svg)](https://github.com/DavyJonesLocker/client_side_validations-simple_form/actions)

[![Maintainability](https://api.codeclimate.com/v1/badges/b9e9cbbd0d9f454adba7/maintainability)](https://codeclimate.com/github/DavyJonesLocker/client_side_validations-simple_form/maintainability)

[![Coverage Status](https://coveralls.io/repos/github/DavyJonesLocker/client_side_validations-simple_form/badge.svg?branch=main)](https://coveralls.io/github/DavyJonesLocker/client_side_validations-simple_form?branch=main)

[Simple Form](https://github.com/heartcombo/simple_form) plugin for [ClientSideValidations](https://github.com/DavyJonesLocker/client_side_validations)

## Installation ##

In your Gemfile add the following:

```ruby

gem 'simple_form'

gem 'client_side_validations'

gem 'client_side_validations-simple_form'

```

Order matters here. `simple_form` and `client_side_validations` need to be

required **before** `client_side_validations-simple_form`.

[Follow the remaining installation instructions for ClientSideValidations](https://github.com/DavyJonesLocker/client_side_validations/blob/main/README.md)

### JavaScript file ###

Instructions depend on your technology stack.

####  When using Webpacker ####

Make sure that you are requiring jQuery and Client Side Validations.

Add the following package:

```sh

yarn add @client-side-validations/simple-form

```

Then, according to the CSS framework and module system you are using, add

**one** of the following lines to your `app/javascript/packs/application.js`

pack:

```js

// No framework / Generic frameworks / Bootstrap 3 with `import` syntax

import '@client-side-validations/simple-form/src'

// Bootstrap 4+ with `import` syntax

import '@client-side-validations/simple-form/src/index.bootstrap4'

// No framework / Generic frameworks / Bootstrap 3 with `require` syntax

require('@client-side-validations/simple-form')

// Bootstrap 4+ with `require` syntax

require('@client-side-validations/simple-form/dist/simple-form.bootstrap4.esm')

```

####  When using Sprockets ####

Make sure that you are requiring jQuery and Client Side Validations.

According to the web framework you are using, add **one** of the following

lines to your `app/assets/javascripts/application.js`, **after**

`//= require rails.validations`

```js

// No framework / Generic frameworks / Bootstrap 3

//= require rails.validations.simple_form

// Bootstrap 4+

//= require rails.validations.simple_form.bootstrap4

```

If you need to copy the asset files from the gem into your project, run:

```

rails g client_side_validations:copy_assets

```

Note: If you run `copy_assets`, you will need to run it again each time you update this project.

## Usage ##

The usage is the same as `ClientSideValidations`, just pass `validate: true` to the form builder

```ruby

<%= simple_form_for @book, validate: true do |book| %>

  <%= book.input :name %>

<% end %>

```

Per-input options are done with `:validate`

```ruby

<%= book.input :name, validate: { presence: true, uniqueness: false } %>

```

## Authors ##

[Brian Cardarella](https://twitter.com/bcardarella)

[Geremia Taglialatela](https://twitter.com/gtagliala)

[We are very thankful for the many contributors](https://github.com/DavyJonesLocker/client_side_validations-simple_form/graphs/contributors)

## Versioning ##

This gem follows [Semantic Versioning](https://semver.org)

## Want to help? ##

Please do! We are always looking to improve this gem. Please see our

[Contribution Guidelines](https://github.com/DavyJonesLocker/client_side_validations-simple_form/blob/main/CONTRIBUTING.md)

on how to properly submit issues and pull requests.

## Legal ##

[DockYard](https://dockyard.com/), LLC © 2012-2023

[@dockyard](https://twitter.com/dockyard)

[Licensed under the MIT license](https://opensource.org/licenses/mit)