Toggle Component API

About Matestack Ui Core Matestack Ui VueJs Matestack Ui Bootstrap
Search…
The toggle component allows us to react to events and toggle the UI state.
Parameters
The toggle component accepts the following parameters:
show_on - optional
The show_on option lets us define an event on which the component gets shown. The content is still rendered on init pageload, but simply hidden in the browser until the event is emitted. If you want to have proper deferred loading, please refer to defer​
1
toggle show_on: 'my_event' do
2
  div id: 'my-div' do
3
    plain 'I was not here before the event'
4
  end
5
end
Copied!
You can pass in multiple, comma-separated events on which the component should be shown.
1
toggle show_on: 'my_event, some_other_event'
Copied!
hide_on - optional
The hide_on option lets us define an event on which the component gets hidden.
1
toggle hide_on: 'my_event' do
2
  div id: 'my-div' do
3
    plain 'You will not see me after the event'
4
  end
5
end
Copied!
You can pass in multiple, comma-separated events on which the component should be hidden.
1
toggle hide_on: 'my_event, some_other_event'
Copied!
hide_after - optional
The hide_after option lets us define a timespan in milliseconds after which the component gets hidden.
1
toggle hide_after: 1000 do
2
  div id: 'my-div' do
3
    plain 'I will be hidden after 1000ms'
4
  end
5
end
Copied!
init_show - optional
The init_show option lets us define if the content should be shown initially.
By default the content is shown initially unless show_on is defined.
init_show is therefore only used in a context like this:
1
toggle show_on: "my_show_event", hide_on: 'my_hide_event', init_show: true do
2
  div id: 'my-div' do
3
    plain "I'm initially shown and then can be toggled based on events"
4
  end
5
end
Copied!
Examples
Show on event
On our example page, we wrap a simple timestamp in an toggle component and tell it to show up when the event my_event gets triggered.
1
class ExamplePage < Matestack::Ui::Page
2
​
3
  def response
4
    toggle show_on: 'my_event' do
5
      div id: 'my-div' do
6
        plain "#{DateTime.now.strftime('%Q')}"
7
      end
8
    end
9
  end
10
​
11
end
Copied!
After our event was fired, the timestamp only is visible on our page!
Hide on event
On our example page, we wrap a simple timestamp in an toggle component and tell it to hide it when the event my_event gets triggered.
1
class ExamplePage < Matestack::Ui::Page
2
​
3
  def response
4
    toggle hide_on: 'my_event' do
5
      div id: 'my-div' do
6
        plain "#{DateTime.now.strftime('%Q')}"
7
      end
8
    end
9
  end
10
​
11
end
Copied!
As expected, the timestamp is only visible before our event was fired and is hidden/invisible after the event!
Hide after show on event
On our example page, we wrap a simple timestamp in an toggle component and tell it to show up when the event my_event gets triggered and be hidden after 1000 milliseconds.
1
class ExamplePage < Matestack::Ui::Page
2
​
3
  def response
4
    toggle show_on: 'my_event', hide_after: 1000 do
5
      div id: 'my-div' do
6
        plain "#{DateTime.now.strftime('%Q')}"
7
      end
8
    end
9
  end
10
​
11
end
Copied!
In this case, the timestamp only is visible after our event was fired, but only for a certain amount of time. After the time is up, it gets hidden!
Show on event with event payload
On our example page, we wrap our toggle event around a placeholder for the event message.
1
class ExamplePage < Matestack::Ui::Page
2
​
3
  def response
4
    toggle show_on: 'my_event' do
5
      div id: 'my-div' do
6
        plain "{{vc.event.data.message}}"
7
      end
8
    end
9
  end
10
​
11
end
Copied!
As an example, we can fire the following event:
1
MatestackUiVueJs.eventHub.$emit("my_event", { message: "test!" })
Copied!
As a result, the event message gets shown after our event was fired!
Combine show_on/hide_on
If you combine show_on and hide_on, you can toggle the view state of the toggle component explicitly.
By default, the content is initially hidden until the show event is emitted when show_on is applied.
1
toggle show_on: "my_show_event", hide_on: 'my_hide_event' do
2
  div id: 'my-div' do
3
    plain 'You will not see me after the event'
4
  end
5
end
Copied!
If you want to display the content initially, simply add init_show: true
1
toggle show_on: "my_show_event", hide_on: 'my_hide_event', init_show: true do
2
  div id: 'my-div' do
3
    plain 'You will not see me after the event'
4
  end
5
end
Copied!
Built-in Reactivity - Previous
Toggle UI States
Next - Built-in Reactivity
Call Server Side Actions
Last modified 4mo ago
Copy link
Contents
Parameters
show_on - optional
hide_on - optional
hide_after - optional
Hide after show on event
Show on event with event payload
Combine show_on/hide_on