README.md in active_admin_sidebar-0.1.0.rc3 vs README.md in active_admin_sidebar-1.0.0
- old
+ new
@@ -1,65 +1,83 @@
-# ActiveAdminSidebar
+# ActiveAdmin Sidebar
-Provides ability to manipulate sidebar position with activeadmin (tested with activeadmin ~> 1.0.0.pre)
+Provides ability to manipulate sidebar position for ActiveAdmin (tested with ActiveAdmin ~> 1.0.0)
+## Install
-Add including of css file
+```ruby
+gem 'active_admin_sidebar'
+# or latest from GitHub
+gem 'active_admin_sidebar', git: 'https://github.com/activeadmin-plugins/active_admin_sidebar.git'
+```
+Add including of CSS file
+
```scss
- @import "active_admin_sidebar";
+ @import "active_admin_sidebar";
```
to the
-```
-app/assets/stylesheets/active_admin.css.scss
```
+app/assets/stylesheets/active_admin.css.scss
+```
And including of coffee file (optional, need only for collapsed sidebar)
-```js
- //= require active_admin_sidebar
+```coffeescript
+ #= require active_admin_sidebar
```
to the
-```
+
+```scss
app/assets/javascripts/active_admin.js
```
-Changing sidebar position dynamically with before_filter
+# Configuration per resource
+
+Changing sidebar position dynamically with before_action
+
```ruby
# app/admin/posts.rb
ActiveAdmin.register Post do
- before_filter :left_sidebar!, only: [:show]
+ before_action :left_sidebar!, only: [:show]
end
# app/admin/comments.rb
ActiveAdmin.register Comment do
- before_filter :right_sidebar!
+ before_action :right_sidebar!
end
```
+## Global configuration
-Moving sidebar to the left within all resource (config/initializers/active_admin.rb)
+Moving sidebar to the left within all resource. Set configuration in `config/initializers/active_admin.rb`
```ruby
- # == Controller Filters
+ # == Controller before-actions
#
- # You can add before, after and around filters to all of your
- # Active Admin resources from here.
- #
- config.before_filter do
- left_sidebar! if respond_to?(:left_sidebar!)
- end
+ # You can add before, after and around actions to all of your resources
+ ActiveAdmin.setup do |config|
+ config.before_action do
+ left_sidebar! if respond_to?(:left_sidebar!)
+ end
+ end
```
-Also you can use sidebar collapsing. It will add css icon in title of first sidebar will save current state in session
+## Collapsing sidebar
+
+You can use sidebar collapsing.
+It will add "hide/show" button. Shown/Hidden state is persisted across all pages.
+
```ruby
left_sidebar!(collapsed: true)
```
-You can override button color according to your color theme:
-```css
+
+You can override button color according to your color theme. For example:
+
+```scss
body.active_admin {
#active_admin_content.left_sidebar, #active_admin_content.collapsed_sidebar {
.collapse_btn, .uncollapse_btn {
background-color: #767270;
}
@@ -67,10 +85,6 @@
}
```
Example
-http://oi45.tinypic.com/1zx1a3r.png
-
-
-
-
+