Module: Onboardable::ClassMethods

Defined in:
lib/onboardable.rb

Overview

Class methods for managing the onboarding process, added to the class that includes the Onboardable module.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#list_builder ⇒ List::Builder 



25
26
27
 
# File 'lib/onboardable.rb', line 25

def list_builder
  @list_builder
end

Instance Method Details

#onboarding(current_step_name = nil) ⇒ List::Base

Builds the onboarding list and optionally sets the current step.



44
45
46
 
# File 'lib/onboardable.rb', line 44

def onboarding(current_step_name = nil)
  list_builder.build(current_step_name)
end

#onboarding=(options = {}) {|List::Builder| ... } ⇒ Step Also known as: has_onboarding

Configures onboarding steps via a ListBuilder with a provided block.

Options Hash (options):

  • :progress_calculation (Proc) —

    A custom calculation for progress percentage. Receives step_index and steps_size as arguments and returns a Float.

Yields:

  • (List::Builder) —

    Executes block in the context of List::Builder.



34
35
36
37
 
# File 'lib/onboardable.rb', line 34

def onboarding=(options = {}, &)
  self.list_builder = List::Builder.new(options)
  list_builder.instance_eval(&)
end