unpoly-rails

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

The

unpoly-rails

gem integrates Unpoly's server protocol into Rails, exposing helper methods in controllers, views, and helpers.

Gem:

unpoly-rails

— tracks Unpoly 3.x

unpoly-rails

gem 将Unpoly的服务器协议集成到Rails中，在控制器、视图和助手类中暴露辅助方法。

Gem：

unpoly-rails

— 适配Unpoly 3.x版本

ruby

undefined

ruby

undefined

gem 'unpoly-rails'

undefined

gem 'unpoly-rails'

undefined

// application.js
//= require unpoly

css

/* application.css
 *= require unpoly
 */

// application.js
//= require unpoly

css

/* application.css
 *= require unpoly
 */

import 'unpoly/unpoly.js'
import 'unpoly/unpoly.css'

import 'unpoly/unpoly.js'
import 'unpoly/unpoly.css'

Helper	Purpose
`up?`	Is this an Unpoly fragment request?
`up.target`	CSS selector being updated (success)
`up.target = 'body'`	Override the render target
`up.target?('.sel')`	Is this selector targeted?
`up.fail_target`	CSS selector targeted for failed responses
`up.any_target?('.sel')`	Is selector targeted for success or failure?
`up.validate?`	Is this a form validation request?
`up.validate_names`	Field names that triggered validation
`up.layer.mode`	Layer mode: `"root"` , `"modal"` , `"drawer"` , etc.
`up.layer.overlay?`	Is the targeted layer an overlay?
`up.layer.root?`	Is the targeted layer the root layer?
`up.layer.accept(value)`	Accept the current overlay
`up.layer.dismiss(value)`	Dismiss the current overlay
`up.layer.open(...)`	Request frontend to open a new overlay
`up.layer.context`	Layer context hash
`up.context`	Alias for `up.layer.context`
`up.emit(type, props)`	Emit event on `document` after update
`up.layer.emit(type, props)`	Emit event on the targeted layer
`up.cache.expire`	Expire the client-side cache
`up.cache.evict`	Evict entries from the client-side cache
`up.title = 'Title'`	Set document title from server
`up.safe_callback("js()")`	CSP-safe inline callback with nonce
`up.render_nothing`	Render empty 204 response
`up.no_vary { }`	Read Unpoly headers without setting Vary

Load when the user's question covers that topic:

server-helpers.md — Full API reference: request inspection, response control, layer API, validation, events, cache control, context, CSP callbacks, failed forms, Vary headers, conditional GETs, common Rails patterns
rails-integration.md — View helper syntax (
```
link_to
```
,
```
form_with
```
,
```
button_to
```
, field helpers), Turbo coexistence (disabling Turbo Drive in Rails 7+), CSP setup with
```
csp_meta_tag
```
, global follow-all config
patterns.md — End-to-end Rails patterns: drawer overlay helper, event-driven subinteractions (
```
up-accept-event
```
/
```
up-dismiss-event
```
), create related record inline + validate parent form, authorization overlay vs root layer

当用户的问题涉及以下主题时加载：

server-helpers.md — 完整API参考：请求检查、响应控制、层级API、验证、事件、缓存控制、上下文、CSP回调、失败表单、Vary头、条件GET、常见Rails模式
rails-integration.md — 视图助手语法（
```
link_to
```
,
```
form_with
```
,
```
button_to
```
, 字段助手）、与Turbo共存（在Rails 7+中禁用Turbo Drive）、使用
```
csp_meta_tag
```
配置CSP、全局follow-all配置
patterns.md — 端到端Rails模式：抽屉浮层助手、事件驱动的子交互（
```
up-accept-event
```
/
```
up-dismiss-event
```
）、内联创建关联记录+验证父表单、授权浮层 vs 根层级