rummage_phoenix下载 - rummage_phoenix源代码下载

rummage_phoenix

其他源码

0.6.0

下载

凤凰城

Rummage.Phoenix是Phoenix的支持框架，可用于通过搜索、排序和分页操作来操作Phoenix集合和Ecto模型。

它通过使用Rummage.Ecto来完成上述操作，对Ecto查询进行分页并向视图和控制器添加 Phoenix 和 HTML 支持。有关如何配置Rummage.Ecto的信息，请访问此页面。

翻阅的最佳部分是所有三个操作： Search 、 Sort和Paginate无缝集成，并且可以单独配置。要查看它们的无缝集成，请查看以下信息。

注意： Rummage与Ransack不同，而且也无意如此。它不会添加基于搜索参数的功能。如果您希望某个模型具有该功能，您可以随时将Rummage配置为使用该模型的Search模块。这就是 Rummage 变得可配置的原因。

在 Phoenix 中无缝搜索、排序和分页！

凤凰都在一起

安装

它以十六进制形式提供，该软件包可以安装为：

将rummage_phoenix添加到mix.exs中的依赖项列表中：

 def deps do
  [
    { :rummage_phoenix , "~> 1.2.0" }
  ]
end

博客

当前博客：

翻查演示和基础知识
使用 Rummage.Ecto
使用 Rummage.Phoenix

接下来：

使用 Rummage.Phoenix 2
使用翻查搜索挂钩
使用 Rumage Sort 钩子
编写自定义 Rummage.Ecto Hook
编写自定义 Rummage.Phoenix HTML 帮助器
将 Rummage 与其他库一起使用：Kerosene
将 Rummage 与其他图书馆结合使用：Scrivener

配置（可选，不是设置`default_per_page`的首选方式）

Rumamge.Phoenix可以使用default_per_page值进行全局配置（可以为模型覆盖）。这不是设置default_per_page的首选方法，因为它可能会导致冲突。建议按模型执行此操作，如下所示的“初始设置”部分。如果要为所有模型设置default_per_page ，请将其添加到web.ex中的model函数中

将rummage_phoenix配置添加到dev.exs中的配置列表中：

 config :rummage_phoenix ,
  Rummage.Phoenix ,
  default_per_page: 5

使用方法（截图对应0.6.0版本，很快会有1.0.0版本的截图）

初始设置

在控制器模块中使用Rummage.Controller ：

 defmodule MyApp.ProductController do
  use MyApp.Web , :controller
  use Rummage.Phoenix.Controller

  # More code below....
end

更改控制器中的index操作：

 def index ( conn , params ) do
  { query , rummage } = Product
    |> Rummage.Ecto . rummage ( params [ "rummage" ] )

  products = Repo . all ( query )

  render conn , "index.html" ,
    products: products ,
    rummage: rummage
end

如果使用搜索功能，请在router.ex中定义search路径（无需定义操作）：

 scope "/" , MyApp do
  pipe_through :browser # Use the default browser stack

  get "/" , PageController , :index
  resources "/products" , ProductController
end

执行此操作本身将允许您通过更新请求的params来搜索、排序和分页。请检查下面的屏幕截图以了解详细信息

使用 Rummage.ViewHelpers

在视图模块中使用Rummage.View ：

 defmodule MyApp.ProductView do
  use MyApp.Web , :view
  use Rummage.Phoenix.View

  # More code below...
end

注意：如果您收到“MyApp.Router.Helpers 不可用”异常，您可以为路由器提供：

 defmodule MyApp.ProductView do
  use MyApp.Web , :view
  use Rummage.Phoenix.View , helpers: MyApp.Web.Router.Helpers

  # More code below...
end

或通过配置：

 config :rummage_phoenix, Rummage.Phoenix, [
  default_helpers: MyApp.Web.Router.Helpers,
]

注意：如果路径助手名称不正确，您可以使用以下命令指定它：

 defmodule MyApp.ProductView do
  use MyApp.Web , :view
  use Rummage.Phoenix.View , struct: "special_product" # will become special_product_path

  # More code below...
end

分页：

将其添加到index.html.eex的底部以呈现Rummage分页链接（确保将rummage从控制器中的index操作传递到视图）：

 < % = pagination_link ( @ conn , @ rummage ) % >

重新加载，您的页面应如下所示：

凤凰分页

排序：

将index.html.eex上的表标题替换为排序链接（确保标题是数据库表中的实际列。）

替换这个：

  < th > Name < / th >
  < th > Price < / th >
  < th > Category < / th >

和：

  < th > < % = sort_link @ conn , @ rummage , [ field: :name , ci: true ] % > < / th >
  < th > < % = sort_link @ conn , @ rummage , [ field: :price ] % > < /th>

OR 对于按关联排序：

  < th > < % = sort_link @ conn , @ rummage , [ field: :name , name: "Category Name" , assoc: [ "category" ] ] % > < /th>

重新加载，这就是您的页面应该如何显示可排序链接而不仅仅是表格标题：

凤凰分拣

注意：目前正在努力向视图添加更好的元素，很快排序链接中的文本箭头将被图标取代

正在搜索：

在index.html.eex中添加一个带有可搜索字段的搜索表单：

 < % = search_form ( @ conn , @ rummage , [ fields:
[
  name: % { label: "Search by Product Name" , search_type: "ilike" } ,
  price: % { label: "Search by Price" , search_type: "eq" } ,
] , button_class: "btn" ,
] ) % >

或者按关联搜索：

 < % = search_form ( @ conn , @ rummage , [ fields:
[
  name: % { label: "Search by Category Name" , search_type: "ilike" , assoc: [ "category" ] }
] , button_class: "btn" ,
] ) % >