organism-ui 0.2.1 → 0.2.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +29 -5
  3. data/lib/ui/engine.rb +2 -0
  4. data/lib/ui/version.rb +1 -1
  5. metadata +16 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3065e937e87ba2c40e0b8a30d1c57402330b7c4452faea8d6220e7188906d2fd
4
- data.tar.gz: 30cee7eb57cc13b3002c328465c215040e9dbff0e8a86d915005200c46305352
3
+ metadata.gz: 468235a6c85fdbf19f9445ba552bf0b4284ef91e5c7d367b0b9783156865461e
4
+ data.tar.gz: 0da770e32328e6d74d021747731a058fafb7df637880e01559f20570d4353918
5
5
  SHA512:
6
- metadata.gz: 2c314d87dc4192fd479015a1b6ae10ad238bb4e5a22b19c5d7a9fb5d31d6b16bd801dff97dbd26743b5931159dd6a3f92e88e3f3116d66a1860451c31bfda36a
7
- data.tar.gz: db8edc5cc1a98bb8deb6da1eae88b000d14211d561a47492d221eacbfd474e773e3ea267b71861d523db95b11739fa52ae0c7e83c87b3bce530a462e53ec0dcf
6
+ metadata.gz: 773f0f3847bcef053d0b9c492231292046969774053631dd51c693a49dd3db32ccabe5a32d3d14870d5f4c40c4cd1261d8e898e7f77e33b358810452dcc30c50
7
+ data.tar.gz: a563ababe28f276975835a02c8156d54f3d6aabea4845f1c53ef5278ea65b917e3e2328df5beac59a79ca63c89293b404d043b1879e0553eaf6ea7ebf749ff63
data/README.md CHANGED
@@ -1,14 +1,27 @@
1
- # Ui
2
- Short description and motivation.
1
+ # Organism Ui
2
+ Ui components made with cells (https://github.com/trailblazer/cells). This library is in ALPHA and subject to change anytime and dramatically before 1.0.
3
3
 
4
4
  ## Usage
5
- How to use my plugin.
5
+
6
+ ### Components
7
+ Components are just configurable cells (https://github.com/trailblazer/cells) for basic ui components. Inspired by ant.design.
8
+
9
+ You render components in your views or controllers:
10
+ ```ruby
11
+ <%= cell(
12
+ Ui::Buttons::Primary,
13
+ 'Primary Button',
14
+ path: '/'
15
+ ) %>
16
+ ```
17
+
18
+ You can see full examples of components in the style guide: https://github.com/nolantait/organism-ui/blob/master/app/views/ui/style_guide/show.html.erb
6
19
 
7
20
  ## Installation
8
21
  Add this line to your application's Gemfile:
9
22
 
10
23
  ```ruby
11
- gem 'ui'
24
+ gem 'organism-ui'
12
25
  ```
13
26
 
14
27
  And then execute:
@@ -18,9 +31,20 @@ $ bundle
18
31
 
19
32
  Or install it yourself as:
20
33
  ```bash
21
- $ gem install ui
34
+ $ gem install organism-ui
22
35
  ```
23
36
 
37
+ ## Style guide
38
+ To quickly style your components you can mount the engine and navigate to an example style guide.
39
+
40
+ ```ruby
41
+ Rails.application.routes.draw do
42
+ mount Ui::Engine => "/ui"
43
+ end
44
+ ```
45
+
46
+ You can then navigate to localhost:3000/ui/style_guide to see your components.
47
+
24
48
  ## Contributing
25
49
  Contribution directions go here.
26
50
 
data/lib/ui/engine.rb CHANGED
@@ -2,6 +2,8 @@ module Ui
2
2
  class Engine < ::Rails::Engine
3
3
  isolate_namespace Ui
4
4
 
5
+ config.autoload_paths << "#{config.root}/lib"
6
+
5
7
  config.generators do |g|
6
8
  g.test_framework :rspec, fixture: false
7
9
  g.fixture_replacement :factory_bot
data/lib/ui/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Ui
2
- VERSION = '0.2.1'
2
+ VERSION = '0.2.12'
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: organism-ui
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.1
4
+ version: 0.2.12
5
5
  platform: ruby
6
6
  authors:
7
7
  - Nolan Tait
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-03-13 00:00:00.000000000 Z
11
+ date: 2021-03-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rails
@@ -156,6 +156,20 @@ dependencies:
156
156
  - - "~>"
157
157
  - !ruby/object:Gem::Version
158
158
  version: 11.1.3
159
+ - !ruby/object:Gem::Dependency
160
+ name: sqlite3
161
+ requirement: !ruby/object:Gem::Requirement
162
+ requirements:
163
+ - - "~>"
164
+ - !ruby/object:Gem::Version
165
+ version: 1.4.2
166
+ type: :development
167
+ prerelease: false
168
+ version_requirements: !ruby/object:Gem::Requirement
169
+ requirements:
170
+ - - "~>"
171
+ - !ruby/object:Gem::Version
172
+ version: 1.4.2
159
173
  description: A collection of ui components implemented in cells.
160
174
  email:
161
175
  - nolanjtait@gmail.com