headmin 0.3.4 → 0.4.0

data/app/views/headmin/forms/_base.html.erb

@@ -1,114 +0,0 @@
-<!--
-<% documentation do %>
-  # Base
-  This serves as a wrapper around most form views. It allows defining everything that happens outside the input field.
-  The main purpose of this view is to coordinate labels and appendages.
-
-  ```erbx
-  <%= form_with do |form| %>
-    <%= render "headmin/forms/base", form: form, attribute: "basic_example" do |form| %>
-      <%= form.text_field("attribute", class: 'form-control') %>
-    <% end %>
-  <% end %>
-  ```
-
-  # Parameters
-  | Name         | Required | Type             | Description |
-  | ------------ | -------- | ---------------- | ----------- |
-  | form         | yes      | Object           | Form object |
-  | attribute    | yes      | String, Symbol   | Name of the attribute of the form model |
-  | append       | no       | Boolean          | Text or icon to be shown on the left hand side of the input, Doesn't work with float |
-  | class        | no       | String           | A space separated string of HTML class names |
-  | float        | no       | Boolean          | Set to true if you want to show floating labels |
-  | id           | no       | String           | Input identifier to be used as "for" in the label |
-  | label        | no       | Hash             | Text to show as label. Label will be hidden if value is false |
-  | prepend      | no       | Boolean          | Text or icon to be shown on the right hand side of the input, Doesn't work with float |
-
-  ## Examples
-
-  ### Sizing
-  ```erbx
-  <%= form_with do |form| %>
-    <%= render "headmin/forms/base", form: form, attribute: "small", class: 'input-group-sm' do |form| %>
-      <%= form.text_field("attribute", class: 'form-control', placeholder: '.input-group-sm') %>
-    <% end %>
-    <%= render "headmin/forms/base", form: form, attribute: "medium" do |form| %>
-      <%= form.text_field("attribute", class: 'form-control', placeholder: 'Default size') %>
-    <% end %>
-    <%= render "headmin/forms/base", form: form, attribute: "large", class: 'input-group-lg' do |form| %>
-      <%= form.text_field("attribute", class: 'form-control', placeholder: '.input-group-lg') %>
-    <% end %>
-  <% end %>
-  ```
-
-  ### Labels
-  ```erbx
-  <%= form_with do |form| %>
-    <%= render "headmin/forms/base", form: form, attribute: "no_label", label: false do |form| %>
-      <%= form.text_field("attribute", class: 'form-control', placeholder: 'Without label') %>
-    <% end %>
-    <%= render "headmin/forms/base", form: form, attribute: "floating_label", float: true do |form| %>
-      <%= form.text_field("attribute", class: 'form-control', placeholder: 'Default size') %>
-    <% end %>
-    <%= render "headmin/forms/base", form: form, attribute: "custom_label", label: 'Custom label' do |form| %>
-      <%= form.text_field("attribute", class: 'form-control') %>
-    <% end %>
-  <% end %>
-  ```
-
-  ### Appendages
-  ```erbx
-  <%= form_with do |form| %>
-    <%= render "headmin/forms/base", form: form, attribute: "prepend", prepend: "€" do |form| %>
-      <%= form.text_field("attribute", class: 'form-control') %>
-    <% end %>
-    <%= render "headmin/forms/base", form: form, attribute: "append", append: "m²" do |form| %>
-      <%= form.text_field("attribute", class: 'form-control') %>
-    <% end %>
-    <%= render "headmin/forms/base", form: form, attribute: "prepend_and_append", prepend: "€", append: "m²" do |form| %>
-      <%= form.text_field("attribute", class: 'form-control') %>
-    <% end %>
-  <% end %>
-  ```
-<% end %>
--->
-
-<% base = Headmin::Form::Base.new(local_assigns) %>
-
-<%= tag.div(class: base.class_names, data: base.data) do %>
-  <% if base.label != false && !base.float %>
-    <%= render 'headmin/forms/label', base.label_options %>
-  <% end %>
-
-  <% if base.append || base.prepend %>
-    <div class="input-group w-100">
-      <% if base.prepend %>
-      <span class="input-group-text">
-        <%= base.prepend %>
-      </span>
-      <% end %>
-
-      <%= yield form %>
-      <%= render 'headmin/forms/validation', base.validation_options if form.object.respond_to?(:errors) %>
-
-      <% if base.append %>
-      <span class="input-group-text">
-        <%= base.append %>
-      </span>
-      <% end %>
-    </div>
-  <% else %>
-    <%= yield form %>
-    <%= render 'headmin/forms/validation', base.validation_options if form.object.respond_to?(:errors) %>
-  <% end %>
-
-  <% if base.label != false && base.float %>
-    <%= render 'headmin/forms/label', base.label_options %>
-  <% end %>
-
-  <% if base.list %>
-    <datalist id="<%= base.list_id %>">
-      <%= options_for_select(base.list) %>
-    </datalist>
-  <% end %>
-<% end %>

data/app/views/headmin/forms/_image.html.erb

@@ -1,21 +0,0 @@
-<%
-  # name: headmin/forms/image
-  #
-  # ==== Required parameters
-  # * +form+ - Form object
-  # * +attribute+ - Name of the attribute of the form model
-  #
-  # ==== Extra parameters
-  # Listed in 'headmin/forms/file'
-  # Listed in 'headmin/forms/base'
-  #
-  # ==== Examples
-  #   Basic version
-  #   <%= render 'headmin/forms/image', form: form, attribute: :image %#>
-
-  options = local_assigns.merge(
-    accept: 'image/*'
-  )
-%>
-
-<%= render 'headmin/forms/file', options %>

data/app/views/headmin/forms/_video.html.erb

@@ -1,21 +0,0 @@
-<%
-  # name: headmin/forms/video
-  #
-  # ==== Required parameters
-  # * +form+ - Form object
-  # * +attribute+ - Name of the attribute of the form model
-  #
-  # ==== Extra parameters
-  # Listed in 'headmin/forms/file'
-  # Listed in 'headmin/forms/base'
-  #
-  # ==== Examples
-  #   Basic version
-  #   <%= render 'headmin/forms/video', form: form, attribute: :video %#>
-
-  options = local_assigns.merge(
-    accept: 'video/*'
-  )
-%>
-
-<%= render 'headmin/forms/file', options %>

data/app/views/headmin/forms/actions/_destroy.html.erb

@@ -1,13 +0,0 @@
-<%#
-    name: headmin/forms/actions/views
-    accepts block: true
-    parameters:
-      form: (object) Form object
-%>
-
-<div class="d-grid">
-  <%= link_to([:admin, form.object], class: "btn btn-outline-danger", "data-turbo-method": "delete", "data-turbo-confirm": t(".confirm")) do %>
-    <%= bootstrap_icon("trash") %>
-    <%= t(".title") %>
-  <% end %>
-</div>

data/app/views/headmin/forms/actions/_save.html.erb

@@ -1,12 +0,0 @@
-<%#
-    name: headmin/forms/actions/views
-    accepts block: true
-    parameters:
-      form: (object) Form object
-%>
-
-<div class="d-grid">
-  <%= form.button type: :submit, class: 'btn btn-lg btn-primary' do  %>
-    <%= t('.title')  %>
-  <% end %>
-</div>

data/app/views/headmin/forms/actions/_view.html.erb

@@ -1,15 +0,0 @@
-<%#
-    name: headmin/forms/actions/views
-    accepts block: true
-    parameters:
-      url: (string) Url for preview
-%>
-
-<% url = local_assigns.has_key?(:url) ? url : nil %>
-
-<div class="d-grid mb-2">
-  <a href="<%= url %>" target="_blank" class="btn h-btn-outline-light">
-    <%= bootstrap_icon('eye') %>
-    <%= t('.title') %>
-  </a>
-</div>

data/docs/blocks-and-fields.md

@@ -1,54 +0,0 @@
-# Blocks + fields = Magic
-
-## Installation
-Run the following generators to generate the migration files.
-```
-rails generate headmin:blocks
-rails generate headmin:fields
-rails db:migrate
-```
-
-## Getting Started
-### Setup model
-
-Setup a block model by including `Headmin::Fieldable`
-
-```ruby
-class Block < ApplicationRecord
-  include Headmin::Block
-  include Headmin::Fieldable
-end
-```
-
-### Setup forms
-
-```erb
-# app/views/admin/blocks/_contact.html.erb
-<%= form.hidden_field :name, value: :contact %>
-
-<!-- Title -->
-<%= render 'headmin/forms/fields/text', form: form, name: :title do |field, attribute, label| %>
-  <%= render 'headmin/forms/text', form: field, attribute: attribute, label: label %>
-<% end %>
-
-<!-- People list -->
-<%= render 'headmin/forms/fields/list', form: form, name: :people do |item| %>
-  <%= render 'headmin/forms/fields/text', form: item, name: :name do |field, attribute, label| %>
-    <%= render 'headmin/forms/text', form: field, attribute: attribute, label: label %>
-  <% end %>
-<% end %>
-```
-
-### Usage in website
-
-```erb
-# app/views/website/blocks/_contact.html.erb
-<% fields = block.fields_hash %>
-
-<h1><%= fields["title"] %></h1>
-<ul>
-  <% fields["people"].each do |person| %>
-    <li><%= person["name"] %></h2></li>
-  <% end %>
-</ul>
-```

data/docs/blocks.md

@@ -1,48 +0,0 @@
-# Blocks 
-
-## Installation
-Run the following generators to generate the migration files.
-```
-rails generate headmin:blocks
-rails db:migrate
-```
-
-## Getting Started
-
-### Setup model
-
-```ruby
-class Page < ApplicationRecord
-  include Headmin::Blockable
-end
-```
-
-### Setup forms
-
-The view "headmin/forms/blocks" will render all the form views for the blocks in the database.
-A hidden template form will be rendered for all types defined in `allow:`
-
-```erb
-# app/views/admin/pages/_form.html.erb
-<%= render 'headmin/form', model: [:admin, @page] do |form| %>
-  <%= render "headmin/forms/blocks", form: form %>
-<% end %>
-```
-
-For each type of block you want to include, create a template in `views/admin/blocks`.
-
-### Usage in frontend
-
-```erb
-# app/views/website/pages/show.html.erb
-<%= render 'headmin/blocks', blockable: @page %>
-```
-
-This will render all the blocks associated with the blockable model (e.g. Page).
-
-For each block in the admin, you'll need to create a corresponding template in your frontend.
-
-```erb
-# app/views/website/blocks/_contact.html.erb
-<%= block.name %>
-```

data/docs/devise.md

@@ -1,41 +0,0 @@
-# Devise
-Headmin comes with some default views for all devise related pages. 
-To make use of them, follow the guidelines below.
-
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'devise'
-```
-
-Run the install generator
-```sh
-$ rails generate devise:install
-```
-
-Create a devise model
-```sh
-$ rails generate devise User
-$ rails db:migrate
-```
-
-Generate the default auth views
-```sh
-$ rails generate headmin:devise
-```
-
-## Getting Started
-
-### Change routes
-Change the default `devise_for` routes with the code below
-
-```ruby
-devise_for :users, controllers: {
-  sessions: 'auth/sessions',
-  registrations: 'auth/registrations',
-  passwords: 'auth/passwords',
-  unlocks: 'auth/unlocks',
-  confirmations: 'auth/confirmations'
-}
-```

data/docs/fields.md

@@ -1,79 +0,0 @@
-# Fields
-
-## Installation
-
-Run the following generators to generate the migration files.
-
-```sh
-$ rails generate headmin:fields
-$ rails db:migrate
-```
-
-## Getting Started
-
-### Setup model
-
-```ruby
-
-class Settings < ApplicationRecord
-  include Headmin::Fieldable
-end
-```
-
-### Setup forms
-
-```html
-# app/views/admin/settings/_form.html.erb
-
-<!-- Company name -->
-<%= render 'headmin/forms/fields/text', form: form, name: :company_name do |field, attribute, label| %>
-  <%= render 'headmin/forms/text', form: field, attribute: attribute, label: label %>
-<% end %>
-
-<!-- People list -->
-<%= render 'headmin/forms/fields/list', form: form, name: :people do |item| %>
-  <%= render 'headmin/forms/fields/text', form: item, name: :name do |field, attribute, label| %>
-    <%= render 'headmin/forms/text', form: field, attribute: attribute, label: label %>
-  <% end %>
-<% end %>
-```
-
-#### Type of fields
-
-- Text: `headmin/forms/fields/text`
-- File: `headmin/forms/fields/file`
-- Image: `headmin/forms/fields/image`
-- List: `headmin/forms/fields/list`
-- Group: `headmin/forms/fields/group`
-
-### Seed database
-
-Use the `fields_hash` setter method to set the data, the way you want to retrieve it.
-
-```ruby
-# In db/seeds.rb
-Setting.create!(
-  name: 'Website settings',
-  fields_hash: {
-    company_name: 'Insiting BV',
-    people: [
-      { name: 'Jef Vlamings' },
-      { name: 'Gert-Jan Peeters' }
-    ]
-  }
-)
-```
-
-### Usage in frontend
-
-```html
-# app/views/website/settings/show.html.erb
-<% fields = @setting.fields_hash %>
-
-<h1><%= fields["company_name"] %></h1>
-<ul>
-    <% fields["people"].each do |person| %>
-    <li><%= person["name"] %></h2></li>
-    <% end %>
-</ul>
-```