каминари гитара что это
Каминари гитара что это
A Scope & Engine based, clean, powerful, customizable and sophisticated paginator for modern web app frameworks and ORMs
Just bundle the gem, then your models are ready to be paginated. No configuration required. Don’t have to define anything in your models or helpers.
Simple Scope-based API
Everything is method chainable with less «Hasheritis». You know, that’s the modern Rails way. No special collection class or anything for the paginated values, instead using a general AR::Relation instance. So, of course you can chain any other conditions before or after the paginator scope.
Customizable Engine-based I18n-aware Helpers
As the whole pagination helper is basically just a collection of links and non-links, Kaminari renders each of them through its own partial template inside the Engine. So, you can easily modify their behaviour, style or whatever by overriding partial templates.
ORM & Template Engine Agnostic
Kaminari supports multiple ORMs (ActiveRecord, DataMapper, Mongoid, MongoMapper) multiple web frameworks (Rails, Sinatra, Grape), and multiple template engines (ERB, Haml, Slim).
The pagination helper outputs the HTML5 tag by default. Plus, the helper supports Rails unobtrusive Ajax.
Ruby 2.1.x, 2.2.x, 2.3.x, 2.4.x, 2.5.x, 2.6.x, 2.7.x, 3.0.x
Rails 4.1, 4.2, 5.0, 5.1, 5.2, 6.0, 6.1
To install kaminari on the default Rails stack, just put this line in your Gemfile:
If you’re building non-Rails of non-ActiveRecord app and want the pagination feature on it, please take a look at Other Framework/Library Support section.
To fetch the 7th page of users (default per_page is 25)
Note: pagination starts at page 1, not at page 0 (page(0) will return the same results as page(1)).
Kaminari does not add an order to queries. To avoid surprises, you should generally include an order in paginated queries. For example:
You can get page numbers or page conditions by using below methods.
To show a lot more users per each page (change the per value)
Note that the per scope is not directly defined on the models but is just a method defined on the page scope. This is absolutely reasonable because you will never actually use per without specifying the page number.
Keep in mind that per internally utilizes limit and so it will override any limit that was set previously. And if you want to get the size for all request records you can use total_count method:
Occasionally you need to pad a number of records that is not a multiple of the page size.
Note that the padding scope also is not directly defined on the models.
If for some reason you need to unscope page and per methods you can call except(:limit, :offset)
General Configuration Options
You can configure the following default values by overriding these values using Kaminari.configure method.
There’s a handy generator that generates the default configuration file into config/initializers directory. Run the following generator command, then edit the generated file.
You can change the method name page to bonzo or plant or whatever you like, in order to play nice with existing page method or association or scope or any other plugin that defines page method on your models.
Configuring Default per_page Value for Each Model by paginates_per
You can specify default per_page value per each model using the following declarative DSL.
Configuring Max per_page Value for Each Model by max_paginates_per
You can specify max per_page value per each model using the following declarative DSL. If the variable that specified via per scope is more than this variable, max_paginates_per is used instead of it. Default value is nil, which means you are not imposing any max per_page value.
Configuring params_on_first_page when using ransack_memory
The Page Parameter Is in params[:page]
Typically, your controller code will look like this:
The Same Old Helper Method
Just call the paginate helper:
The paginate Helper Method
Specifying the «inner window» Size (4 by default)
Specifying the «outer window» Size (0 by default)
Outer Window Can Be Separately Specified by left, right (0 by default)
Changing the Parameter Name ( :param_name ) for the Links
This would modify the query parameter name on each links.
Extra Parameters ( :params ) for the Links
Ajax Links (crazy simple, but works perfectly!)
This would add data-remote=»true» to all the links inside.
Specifying an Alternative Views Directory (default is kaminari/)
The link_to_next_page and link_to_previous_page (aliased to link_to_prev_page ) Helper Methods
This simply renders a link to the next page. This would be helpful for creating a Twitter-like pagination feature.
The helper methods support a params option to further specify the link. If format needs to be set, inlude it in the params hash.
The page_entries_info Helper Method
This renders a helpful message with numbers of displayed vs. total entries.
By default, the message will use the humanized class name of objects in collection: for instance, «project types» for ProjectType models. The namespace will be cut out and only the last name will be used. Override this with the :entry_name parameter:
The rel_next_prev_link_tags Helper Method
This renders the rel next and prev link tags for the head.
The path_to_next_page Helper Method
This returns the server relative path to the next page.
The path_to_prev_page Helper Method
This returns the server relative path to the previous page.
The default labels for ‘first’, ‘last’, ‘previous’, ‘. ‘ and ‘next’ are stored in the I18n yaml inside the engine, and rendered through I18n API. You can switch the label value per I18n.locale for your internationalized application. Keys and the default values are the following. You can override them by adding to a YAML file in your Rails.root/config/locales directory.
If you use non-English localization see i18n rules for changing one_page:display_entries block.
Customizing the Pagination Helper
Kaminari includes a handy template generator.
To Edit Your Paginator
Run the generator first,
then edit the partials in your app’s app/views/kaminari/ directory.
For Haml/Slim Users
that will generate partials in app/views/admin/kaminari/ directory.
The generator has the ability to fetch several sample template themes from the external repository (https://github.com/amatsuda/kaminari_themes) in addition to the bundled «default» one, which will help you creating a nice looking paginator.
To see the full list of available themes, take a look at the themes repository, or just hit the generator without specifying THEME argument.
To utilize multiple themes from within a single application, create a directory within the app/views/kaminari/ and move your custom template files into that directory.
Next, reference that directory when calling the paginate method:
Note: if the theme isn’t present or none is specified, kaminari will default back to the views included within the gem.
Paginating Without Issuing SELECT COUNT Query
Generally the paginator needs to know the total number of records to display the links, but sometimes we don’t need the total number of records and just need the «previous page» and «next page» links. For such use case, Kaminari provides without_count mode that creates a paginatable collection without counting the number of all records. This may be helpful when you’re dealing with a very large dataset because counting on a big table tends to become slow on RDBMS.
In your view file, you can only use simple helpers like the following instead of the full-featured paginate helper:
Paginating a Generic Array object
Kaminari provides an Array wrapper class that adapts a generic Array object to the paginate view helper. However, the paginate helper doesn’t automatically handle your Array object (this is intentional and by design). Kaminari::paginate_array method converts your Array object into a paginatable Array that accepts page method.
You can specify the total_count value through options Hash. This would be helpful when handling an Array-ish object that has a different count value from actual count such as RSolr search result or when you need to generate a custom pagination. For example:
or, in the case of using an external API to source the page of data:
Creating Friendly URLs and Caching
Because of the page parameter and Rails routing, you can easily generate SEO and user-friendly URLs. For any resource you’d like to paginate, just add the following to your routes.rb :
If you are using Rails 4 or later, you can simplify route definitions by using concern :
Because the page parameter is now a URL segment, we can leverage on Rails page caching!
Other Framework/Library Support
Technically, the kaminari gem consists of 3 individual components:
So, bundling gem ‘kaminari’ is equivalent to the following 2 lines (kaminari-core is referenced from the adapters):
For Other ORM Users
If you want to use other supported ORMs instead of ActiveRecord, for example Mongoid, bundle its adapter instead of kaminari-activerecord.
Kaminari currently provides adapters for the following ORMs:
For Other Web Framework Users
If you want to use other web frameworks instead of Rails + Action View, for example Sinatra, bundle its adapter instead of kaminari-actionview.
Kaminari currently provides adapters for the following web frameworks:
For More Information
Check out Kaminari recipes on the GitHub Wiki for more advanced tips and techniques. https://github.com/kaminari/kaminari/wiki/Kaminari-recipes
Feel free to message me on Github (amatsuda) or Twitter (@a_matsuda) ☇☇☇ 🙂
Contributing to Kaminari
Fork, fix, then send a pull request.
To run the test suite locally against all supported frameworks:
To target the test suite against one framework:
Copyright (c) 2011- Akira Matsuda. See MIT-LICENSE for further details.
About
⚡ A Scope & Engine based, clean, powerful, customizable and sophisticated paginator for Ruby webapps