kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity
rails--rails/actionview/app/assets/javascripts/README.md

58 lines
2.1 KiB
Markdown
Raw Normal View History

rails-ujs: Update README Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn).
2017-10-02 17:45:32 -04:00
# Ruby on Rails unobtrusive scripting adapter
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
This unobtrusive scripting support file is developed for the Ruby on Rails framework, but is not strictly tied to any specific backend. You can drop this into any application to:
- force confirmation dialogs for various actions;
- make non-GET requests from hyperlinks;
- make forms or hyperlinks submit data asynchronously with Ajax;
- have submit buttons become automatically disabled on form submit to prevent double-clicking.
Adding docs link to ujs readme
2021-06-28 16:52:11 -04:00
These features are achieved by adding certain [`data` attributes][data] to your HTML markup. Documentation about the various supported `data` attributes is [available here][ujsdocs]. In Rails, they are added by the framework's template helpers.
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
rails-ujs: Update README Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn).
2017-10-02 17:45:32 -04:00
## Optional prerequisites
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
rails-ujs: Update README Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn).
2017-10-02 17:45:32 -04:00
Note that the `data` attributes this library adds are a feature of HTML5. If you're not targeting HTML5, these attributes may make your HTML to fail [validation][validator]. However, this shouldn't create any issues for web browsers or other user agents.
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
rails-ujs: Update README Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn).
2017-10-02 17:45:32 -04:00
## Installation
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
NPM -> npm [ci skip] According to https://www.npmjs.com/.
2019-05-12 05:59:14 -04:00
### npm
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
Move all npm packages to @rails scope Fixes #33083
2019-01-09 08:09:51 -05:00
npm install @rails/ujs --save
rails-ujs: Update README Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn).
2017-10-02 17:45:32 -04:00
### Yarn
Move all npm packages to @rails scope Fixes #33083
2019-01-09 08:09:51 -05:00
yarn add @rails/ujs
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
Update rails-ujs readme Add a note on using `yarn autoclean`.
2018-02-04 00:19:28 -05:00
Ensure that `.yarnclean` does not include `assets` if you use [yarn autoclean](https://yarnpkg.com/lang/en/docs/cli/autoclean/).
rails-ujs: Update README Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn).
2017-10-02 17:45:32 -04:00
## Usage
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
rails-ujs: Update README Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn).
2017-10-02 17:45:32 -04:00
### Asset pipeline
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
rails-ujs: Update README Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn).
2017-10-02 17:45:32 -04:00
In a conventional Rails application that uses the asset pipeline, require `rails-ujs` in your `application.js` manifest:
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
```javascript
//= require rails-ujs
```
rails-ujs: Update README Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn).
2017-10-02 17:45:32 -04:00
### ES2015+
Update to rails-ujs documentation for yarn install
2017-05-19 16:42:38 -04:00
rails-ujs: Update README Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn).
2017-10-02 17:45:32 -04:00
If you're using the Webpacker gem or some other JavaScript bundler, add the following to your main JS file:
Update to rails-ujs documentation for yarn install
2017-05-19 16:42:38 -04:00
```javascript
Use ES module syntax for application.js.tt and docs This change swaps the CommonJS require() syntax in the Webpacker application.js pack template file and in documentation examples with ES module import syntax. Benefits of this change include: Provides continuity with the larger frontend community: Arguably, one of the main draws in adopting Webpacker is its integration with Babel to support ES module syntax. For a fresh Rails install with Webpacker, the application.js file will be the first impression most Rails developers have with webpack and Webpacker. Most of the recent documentation and examples they will find online for using other libraries will be based on ES module syntax. Reduces confusion: Developers commonly add ES imports to their application.js pack, typically by following online examples, which means mixing require() and import statements in a single file. This leads to confusion and unnecessary friction about differences between require() and import. Embraces browser-friendliness: The ES module syntax forward-looking and is meant to be supported in browsers. On the other hand, require() syntax is synchronous by design and not browser-supported as CommonJS originally was adopted in Node.js for server-side JavaScript. That webpack supports require() syntax is merely a convenience. Encourages best practices regarding optimization: webpack can statically analyze ES modules and "tree-shake", i.e., strip out unused exports from the final build (given certain conditions are met, including `sideEffects: false` designation in package.json).
2020-06-02 23:27:43 -04:00
import Rails from "@rails/ujs"
Rails.start()
Update to rails-ujs documentation for yarn install
2017-05-19 16:42:38 -04:00
```
rails-ujs: Update README Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn).
2017-10-02 17:45:32 -04:00
## How to run tests
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
Update test link in ActionView javascripts README.md. [ci skip]
2017-05-22 03:57:00 -04:00
Run `bundle exec rake ujs:server` first, and then run the web tests by visiting http://localhost:4567 in your browser.
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
## License
rails-ujs: Update README Make various wording tweaks to cater to users who are viewing the README on NPM. Notably, don't highlight Yarn specifically in the installation instructions -- even though this is the preferred tool of choice especially in the Ruby community, some people still use NPM (and, really, ES2015+ syntax has nothing to do with NPM or Yarn).
2017-10-02 17:45:32 -04:00
Move rails-ujs README and LICENCE to actionview We are going to make rails/rails the official repository
2017-02-21 13:30:19 -05:00
rails-ujs is released under the [MIT License](MIT-LICENSE).
Update rails-ujs readme Link to W3C reference was broken, this uses the latest URL, along with HTTPS.
2018-01-29 19:18:35 -05:00
[data]: https://www.w3.org/TR/html5/dom.html#embedding-custom-non-visible-data-with-the-data-attributes "Embedding custom non-visible data with the data-* attributes"
Updated links from http to https in guides, docs, etc
2019-03-08 06:36:16 -05:00
[validator]: https://validator.w3.org/
[csrf]: https://api.rubyonrails.org/classes/ActionController/RequestForgeryProtection.html
Adding docs link to ujs readme
2021-06-28 16:52:11 -04:00
[ujsdocs]: https://github.com/rails/jquery-ujs/wiki
Copy permalink