clearwater-virtual_list 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6802029dc7bf2e5fbe3d38344ce15197d3e7d07a8c44f2e10eae8f575df451c0
-  data.tar.gz: a8cfeb648351da3bd5de72858c61856f12db918e850b4de1cd8888627d01ee61
+  metadata.gz: 22a47bedba29fe5d2d72109c855c6ec1cd72853b3c1fcc90a769bb886d8113f5
+  data.tar.gz: fce48744632137a2f4af3b35614f7f53c609082f5de96964e7eff2f92e27d466
 SHA512:
-  metadata.gz: f31107cab21fecd8e128f6dfb7d2d7cd96693e4d03ac0763546dc2521fc2d5404a2f084d3d69ed3ea640eb5a14fcc04be0e354784eee74c4f7db3988f806b555
-  data.tar.gz: bd20de801e88703e041a98adb4398b74a99cb9459626af8fdd5fdcde3b673dc124d9022bcac5a4feb2827ed8179b6491635e169a8e658168c27088ac28e97d6d
+  metadata.gz: d09f627c325fbe2967bc5cc49dca340d50cf488844735ea8f4f85ade2f0421948413b4786b23d4e56e374249d449547ea31311c0a2df47d730d0eef2f1f7699e
+  data.tar.gz: 72696cc87832ffb93a3d28be7671ee4a32386bad9df6172619503efc762f4ae123d809f7932d0494651378d553a9217c823012c9ca7e4bf5b24bba3c144decf5

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+Gemfile.lock

data/README.md

@@ -1,8 +1,6 @@
 # Clearwater::VirtualList
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/clearwater/virtual_list`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Render a virtual list of Clearwater components where list items outside of the visible area of the page are not rendered. They are inserted just in time while scrolling and removed when they are no longer visible.
 
 ## Installation
 
@@ -22,7 +20,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Inside your Clearwater app:
+
+```ruby
+require 'clearwater/virtual_list'
+
+# Define the virtual list component in terms of your regular list component
+MyVirtualList = Clearwater::VirtualList.create do |items:, list_style:, item_style:|
+  MyList.new(
+    items: items,
+    list_style: list_style,
+    item_style: item_style,
+  )
+end
+```
+
+Use the `items` and `item_height` keyword arguments to the component when using it:
+
+```ruby
+class Layout
+  include Clearwater::Component
+
+  def render
+    div([
+      h1('My list of things'),
+      MyVirtualList.new(
+        items: all_the_things, # The full list of items
+        item_height: 100,      # The height of each item in pixels
+      ),
+    ])
+  end
+end
+```
 
 ## Development
 
@@ -32,7 +61,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clearwater-virtual_list. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/clearwater-rb/clearwater-virtual_list. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +69,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Clearwater::VirtualList project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/clearwater-virtual_list/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Clearwater::VirtualList project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/clearwater-rb/clearwater-virtual_list/blob/master/CODE_OF_CONDUCT.md).

data/lib/clearwater/virtual_list/version.rb

@@ -1,5 +1,5 @@
 module Clearwater
   module VirtualList
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/opal/clearwater/virtual_list.rb

@@ -15,7 +15,7 @@ module Clearwater
               box_sizing: 'border-box',
             },
             item_style: {
-              height: "#{@item_height}px",
+              height: "#{height}px",
               box_sizing: 'border-box',
             },
           )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clearwater-virtual_list
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jamie Gaskins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-25 00:00:00.000000000 Z
+date: 2018-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler