Skip to content

Commit 2d2e686

Browse files
committed
Replace static screenshot with animated GIF demo in README
- Add demo.gif showing collapsible sidebar in action - Update README collapsible sidebar docs for v3 API - Remove old screen/sidebar.jpg
1 parent ad7c461 commit 2d2e686

3 files changed

Lines changed: 9 additions & 18 deletions

File tree

README.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -93,27 +93,18 @@ Moving sidebar to the left within all resource. Set configuration in `config/ini
9393
end
9494
```
9595

96-
## Collapsing sidebar
96+
## Collapsible sidebar
9797

98-
You can use sidebar collapsing.
99-
It will add "hide/show" button. Shown/Hidden state is persisted across all pages.
98+
Add a toggle button to collapse/expand the sidebar. State is persisted per-resource across page navigations.
10099

101100
```ruby
102-
left_sidebar!(collapsed: true)
103-
```
104-
105-
You can override button color according to your color theme. For example:
101+
# Collapsible sidebar (starts expanded)
102+
left_sidebar!(collapsible: true)
103+
right_sidebar!(collapsible: true)
106104

107-
```scss
108-
body.active_admin {
109-
#active_admin_content.left_sidebar, #active_admin_content.collapsed_sidebar {
110-
.collapse_btn, .uncollapse_btn {
111-
background-color: #767270;
112-
}
113-
}
114-
}
105+
# Collapsible sidebar (starts collapsed)
106+
left_sidebar!(collapsible: true, start_collapsed: true)
107+
right_sidebar!(collapsible: true, start_collapsed: true)
115108
```
116109

117-
Example
118-
119-
![Alt text](https://raw.githubusercontent.com/activeadmin-plugins/active_admin_sidebar/master/screen/sidebar.jpg "Example")
110+
![Demo](https://raw.githubusercontent.com/activeadmin-plugins/active_admin_sidebar/master/demo.gif "Collapsible sidebar demo")

demo.gif

574 KB
Loading

screen/sidebar.jpg

-128 KB
Binary file not shown.

0 commit comments

Comments
 (0)