ProMotion-XLForm 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05c859ed838fdd140e797b1dcbe49c572398a592
-  data.tar.gz: 6c48299595d9d3324c4495169245c6339cb5adbb
+  metadata.gz: 9890e1816bb0725731ac8e10e8413c4d22063a0a
+  data.tar.gz: fd5779aab6a93194f091e0e323f7ba0c4ca88890
 SHA512:
-  metadata.gz: '0885792527bcbd81684b5bc5f9505c447a011fd3e27c9f14700c9d83cfd11522709a54b25a975bc71cc645f253baa71c6363d1f7df0e4a37350bb3d089933811'
-  data.tar.gz: 897df3976ae5e677566390e7370602eebf954bdd37769f54bfc21816c0640d2e532b0d9cd89a966169a589af18e5c5873fa6c2203fce256941e926674ce65d21
+  metadata.gz: 807971c87855a87079cca5b9ca9b8548fdfebce2fe89d66373e54121131fddf1cceb8e35b34256e73b15ff3528b7a0481e9b1c4b5c352075e1ed640c4f304ccb
+  data.tar.gz: '0727936efd3e9068df4d98341eb71467d00b8f81d3986bd02b6538951be00eb78ecdeffebe99063ed622c29c5514337a79eca3aa8e313216dea88a0d2db19849'

data/README.md

@@ -19,9 +19,9 @@ $ rake pod:install
 
 ## Usage
 
-`PM::XLFormScreen` include `PM::ScreenModule` so you'll have all ProMotion methods available.
+`PM::XLFormScreen` includes `PM::ScreenModule` so you'll have all the same ProMotion screen methods available.
 
-To create a form, create a new `PM::XLFormScreen` and implement `form_data`.
+To create a form screen, subclass `PM::XLFormScreen` and define a `form_data` method.
 
 ```ruby
 class TestFormScreen < PM::XLFormScreen
@@ -107,30 +107,53 @@ end
 * :image (ProMotion-XLForm specific)
 * :color (ProMotion-XLForm specific using [RSColorPicker](https://github.com/RSully/RSColorPicker))
 
-### Class options
+### Form Options
+
+The `form_options` class method allows you to customize the default behavior of the form.
 
 ```ruby
 class TestFormScreen < PM::XLFormScreen
 
-  form_options required:  :asterisks, # add an asterisk to required fields
-               on_save:   :'save_form:', # will be called when you touch save
-               on_cancel: :cancel_form, # will be called when you touch cancel
-               auto_focus: true # the form will focus on the first focusable field
+  form_options on_save:   :save_form,   # adds a "Save" button in the nav bar and calls this method
+               on_cancel: :cancel_form, # adds a "Cancel" button in the nav bar and calls this method
+               required:  :asterisks,   # display an asterisk next to required fields
+               auto_focus: true         # the form will focus on the first focusable field
 
-   def save_form(values)
-     dismiss_keyboard
-     mp values
-   end
+  def save_form(values)
+    dismiss_keyboard
+    mp values
+  end
 
-   def cancel_form
-   end
+  def cancel_form
+  end
 end
 ```
 
-If you don't want the default navigation controller buttons, you could add something like
+#### Save & Cancel Buttons
+
+By default, no buttons are displayed in the nav bar unless you configure the `on_save` or `on_cancel` options.
+
+You can either pass the name of the method that you want to call when that button is tapped, or you can pass a hash of options, allowing you to configure the title of the button.
+
+**Hash Options:**
+- `title` or `system_item` - The button text or system item that will be displayed.
+- `action` - The method that will be called when the button is tapped.
 
 ```ruby
+form_options on_cancel: { system_item: :trash, action: :cancel_form },
+             on_save: { title: 'Continue', action: :continue }
+```
 
+`system_item` can be any `UIBarButtonSystemItem` constant or one of the following symbols:
+```ruby
+:done, :cancel, :edit, :save, :add, :flexible_space, :fixed_space, :compose,
+:reply, :action, :organize, :bookmarks, :search, :refresh, :stop, :camera,
+:trash, :play, :pause, :rewind, :fast_forward, :undo, :redo
+```
+
+If you would like to display a button as part of your form, you could do something like this:
+
+```ruby
 form_options on_save: :my_save_method
 
 def form_data
@@ -253,7 +276,48 @@ class MyValueTransformer < PM::ValueTransformer
 end
 ```
 
-For a more advanced custom selector, you can set `view_controller_class:`. See [XLForm documentation](https://github.com/xmartlabs/XLForm/#custom-selectors---selector-row-with-a-custom-selector-view-controller) for more informations.
+#### Custom Selector View Controller
+
+For a more advanced custom selector, you can set `view_controller_class:`.
+
+```ruby
+{
+  title: 'Person',
+  name: 'person',
+  type: :selector_push,
+  view_controller_class: PeopleListScreen
+}
+```
+
+Here is an example of a table screen. Note that the `rowDescriptor` setter must be implemented. In order to pass the value back to the previous form screen, update the value of the `rowDescriptor`. Note that XLForm will set the `rowDescriptor` later in your view controller's initialization process than you might expect.
+
+```ruby
+class PeopleListScreen < PM::TableScreen
+  attr_accessor :rowDescriptor
+
+  def table_data
+    [{
+      title: @rowDescriptor.title,
+      cells: People.all.map do |person|
+        {
+          title: person.name,
+          action: -> {
+            rowDescriptor.value = person.id
+            close # go back to the previous screen
+          }
+        }
+      end
+    }]
+  end
+end
+```
+
+![Screenshot of Map Custom Selector](https://github.com/xmartlabs/XLForm/raw/master/Examples/Objective-C/Examples/Selectors/CustomSelectors/XLFormRowViewController/XLForm-map-custom-selector.gif)
+
+![Screenshot of Dynamic Custom Selector](https://github.com/xmartlabs/XLForm/raw/master/Examples/Objective-C/Examples/Selectors/DynamicSelector/XLForm-dynamic-custom-selector.gif)
+
+See [XLForm documentation](https://github.com/xmartlabs/XLForm/#custom-selectors---selector-row-with-a-custom-selector-view-controller) for more information.
+
 
 ### Cell
 

data/lib/ProMotion/XLForm/xl_form_view_controller.rb

@@ -11,6 +11,12 @@ module ProMotion
       s
     end
 
+    def init
+      super.tap do
+        screen_init if respond_to?(:screen_init)
+      end
+    end
+
     def loadView
       self.respond_to?(:load_view) ? self.load_view : super
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ProMotion-XLForm
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Benjamin Michotte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-30 00:00:00.000000000 Z
+date: 2018-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ProMotion