publishing_platform_publishing_components 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c220b3353f06ea1deb75bcc07e60a7eeeb269793c1bbe9712a5ab970230a7d98
-  data.tar.gz: c68ad207fdf6ced57cba965674ab4285c945f086c0b603e1a6383573006df990
+  metadata.gz: d3a0f4aacb926c1e893eabd21a66d180dc9d2eccd55715f8db452d7bd1ab3329
+  data.tar.gz: 914d59568ba62d0f8355595f0e16c566b279ed2a43fd839e63bd9c206ca1a7dc
 SHA512:
-  metadata.gz: c0073afe1fa51c7740e1830495124bf99a4aee701cdf33e498f21c3525f756a143950aa40ef533a0f8d2a6b4e809c2908091c36b32fd3088969b2de6ed9af3f5
-  data.tar.gz: 7217522d3598a41d937e8aa8e4d5084bb2df08c908bc40b8f13cceb5c02aa6e6c98aafd7c788d46fbfc85c9bf03e62dc57d7b4b7f63675356404abbde7ecc40a
+  metadata.gz: eb2579df1df8c926594ae3d734b82e48cc6a6c7bcb7962df67ea0192e502bdd5784c2058da259989f904a0bb322ab086ec29c3c18d32c08a6f768e066dbf22ee
+  data.tar.gz: 565c9cbe5ac2559e5987a39d1c13fcd8d21fd43b30554e301f1a3aca2f6be167f38c3ad8015c84a1cdfb80c6d596d6b3fe9e0c8a742831b32d0e35f6d1fe838c

data/app/assets/stylesheets/publishing_platform_publishing_components/_all_components.scss

@@ -1,5 +1,6 @@
 @import "bootstrap";
 @import "components/attachment";
 @import "components/attachment-link";
+@import "components/inset-text";
 @import "components/layout";
 @import "components/summary-list";

data/app/assets/stylesheets/publishing_platform_publishing_components/components/_inset-text.scss

@@ -0,0 +1,29 @@
+@import 'functions';
+@import 'variables';
+@import 'mixins';
+
+.gem-c-inset-text {
+  padding: 15px;
+
+  // Margin top intended to collapse
+  // This adds an additional 10px to the paragraph above
+  margin-top: 20px;
+  margin-bottom: 20px;
+
+  @include media-breakpoint-up(sm) {
+    margin-top: 30px;
+    margin-bottom: 30px;
+  }  
+
+  clear: both;
+  border-left: 10px solid $gray-500;
+
+  > :first-child {
+    margin-top: 0;
+  }
+
+  > :only-child,
+  > :last-child {
+    margin-bottom: 0;
+  }
+}

data/app/views/publishing_platform_publishing_components/components/_inset_text.html.erb

@@ -0,0 +1,14 @@
+<%
+  id ||= "inset-text-#{SecureRandom.hex(4)}"
+
+  component_helper = PublishingPlatformPublishingComponents::Presenters::ComponentWrapperHelper.new(local_assigns)
+  component_helper.add_class("gem-c-inset-text")
+  component_helper.set_id(id)
+%>
+<%= tag.div(**component_helper.all_attributes) do %>
+  <% if defined? text %>
+    <%= text %>
+  <% elsif block_given? %>
+    <%= yield %>
+  <% end %>
+<% end %>

data/app/views/publishing_platform_publishing_components/components/docs/inset_text.yml

@@ -0,0 +1,19 @@
+name: Inset text
+description: Use the inset text component to differentiate a block of text from the content that surrounds it.
+uses_component_wrapper_helper: true
+accessibility_criteria: |
+  All text must have a contrast ratio higher than 4.5:1 against the background colour to meet [WCAG AA](https://www.w3.org/TR/WCAG20/#visual-audio-contrast-contrast)
+examples:
+  default:
+    data:
+      text: "It can take up to 8 weeks to register a lasting power of attorney if there are no mistakes in the application."
+
+  with_block:
+    description: |
+      Note that the contents should be styled separately from the component, which takes no responsibility for what it is passed.
+    data:
+      block: |
+        <div>
+          <h2 id='heading'>To publish this step by step you need to</h2>
+          <a href='/foo'>Check for broken links</a>
+        </div>

data/lib/publishing_platform_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module PublishingPlatformPublishingComponents
-  VERSION = "0.5.0".freeze
+  VERSION = "0.6.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_publishing_components
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Publishing Platform
@@ -177,6 +177,7 @@ files:
 - app/assets/stylesheets/publishing_platform_publishing_components/_all_components.scss
 - app/assets/stylesheets/publishing_platform_publishing_components/components/_attachment-link.scss
 - app/assets/stylesheets/publishing_platform_publishing_components/components/_attachment.scss
+- app/assets/stylesheets/publishing_platform_publishing_components/components/_inset-text.scss
 - app/assets/stylesheets/publishing_platform_publishing_components/components/_layout.scss
 - app/assets/stylesheets/publishing_platform_publishing_components/components/_summary-list.scss
 - app/controllers/publishing_platform_publishing_components/application_controller.rb
@@ -189,6 +190,7 @@ files:
 - app/views/publishing_platform_publishing_components/components/_attachment.html.erb
 - app/views/publishing_platform_publishing_components/components/_attachment_link.html.erb
 - app/views/publishing_platform_publishing_components/components/_error_summary.html.erb
+- app/views/publishing_platform_publishing_components/components/_inset_text.html.erb
 - app/views/publishing_platform_publishing_components/components/_layout.html.erb
 - app/views/publishing_platform_publishing_components/components/_navigation.html.erb
 - app/views/publishing_platform_publishing_components/components/_summary_list.html.erb
@@ -201,6 +203,7 @@ files:
 - app/views/publishing_platform_publishing_components/components/docs/attachment.yml
 - app/views/publishing_platform_publishing_components/components/docs/attachment_link.yml
 - app/views/publishing_platform_publishing_components/components/docs/error_summary.yml
+- app/views/publishing_platform_publishing_components/components/docs/inset_text.yml
 - app/views/publishing_platform_publishing_components/components/docs/navigation.yml
 - app/views/publishing_platform_publishing_components/components/docs/summary_list.yml
 - config/initializers/assets.rb
@@ -449,7 +452,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.1
+rubygems_version: 4.0.2
 specification_version: 4
 summary: A gem to document components in Publishing Platform frontend applications
 test_files: []