katalyst-content 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9add66f2ceddd578d133b679abf018fc4af299b100ab60b12c93e701e0681c3f
-  data.tar.gz: 6432a682a93e61c38b3bbaecc3dc392c9be03070838094cbd195646e6a0bcdcf
+  metadata.gz: 32b03e6922fb9f2062318ea0fa31fc988463ac2975d9f5ba193187638c4528f2
+  data.tar.gz: 1830d2633def549737b742d4c29fddf5a419e253365b1c59f5a40ebbec445d90
 SHA512:
-  metadata.gz: 74ef81a842d28873e577a245a84a97649814d2fdd1387e25cb2fcb273fca7edf4c5fee147bcfcddf3c556a66d11bb9d58705b73e9daae383271fd1ab93ed0362
-  data.tar.gz: 1a8dd6463ff2146bf80ffaecb05adc76e866d956d89544c3257dc2a38be4f8f38d3c86090e464a2571d37108cf3a5d8ceb8e9ffa0223d83cdee435791cd5c7c6
+  metadata.gz: 63ccbcf8ce1f61175eabb29a7d0d88385245a315c487ce4e78055467a6ada93998592aeb882d1c3b1475a6f864a056166caeac31e69df91522dc7a15f3926f4a
+  data.tar.gz: 9b301a53e876f2c76b7e8854429c009af2aa6dd8637c6f76e4f810bb4c44c5d6cb60136dc03e33dbcae66472c5457cbec781ec2a1acd86b8e78d2d2166b17858

data/README.md

@@ -5,19 +5,37 @@ applications.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install the gem as usual
 
 ```ruby
-gem 'katalyst-content'
+gem "katalyst-content"
 ```
 
-And then execute:
+Mount the engine in your `routes.rb` file:
 
-    $ bundle install
+```ruby
+mount Katalyst::Content::Engine, at: "content"
+```
 
-Or install it yourself as:
+Add the Gem's migrations to your application:
 
-    $ gem install katalyst-content
+```ruby
+rake katalyst_content:install:migrations
+```
+
+Add the Gem's javascript and CSS to your build pipeline. This assumes that
+you're using `rails-dartsass` and `importmaps` to manage your assets.
+
+```javascript
+// app/javascript/controllers/application.js
+import { application } from "controllers/application";
+import content from "@katalyst/content";
+application.load(content);
+```
+
+```sass
+@use "katalyst/content";
+```
 
 ## Usage
 
@@ -80,11 +98,67 @@ FactoryBot.define do
 end
 ```
 
+Create a controller for editing content. This example assumes you're rendering the editor on the 'show' route of an
+admin controller.
+
+```ruby
+class Admin::PagesController < Admin::BaseController
+  before_action :set_page, only: %i[show update]
+  
+  def show; end
+
+  def update
+    @page.attributes = page_params
+
+    unless @page.valid?
+      return respond_to do |format|
+        format.turbo_stream { render @editor.errors, status: :unprocessable_entity }
+      end
+    end
+
+    case params[:commit]
+    when "publish"
+      @page.save!
+      @page.publish!
+    when "save"
+      @page.save!
+    when "revert"
+      @page.revert!
+    end
+
+    redirect_to [:admin, @page], status: :see_other
+  end
+  
+  private
+  
+  def set_page
+    @page = Page.find(params[:id])
+    @editor = Katalyst::Content::EditorComponent.new(container: @page)
+  end
+
+  def page_params
+    params.require(:page).permit(items_attributes: %i[id index depth])
+  end
+end
+```
+
+And the view:
+
+```erb
+<%# app/views/admin/pages/show.html.erb %>
+<%= render @editor.status_bar %>
+<%= render @editor %>
+<%# We suggest you render new items in a sidebar %>
+<%= render @editor.new_items %>
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number and run `bundle exec rake release`, which will create a git tag for the version, push git commits and
+the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing