Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make displaying the preview optional #400

Merged
merged 1 commit into from
Jul 10, 2018
Merged

Make displaying the preview optional #400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions app/models/govuk_publishing_components/component_doc.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ def display_html?
component[:display_html]
end

def display_preview?
component[:display_preview].nil? ? true : component[:display_preview]
end

def html_body
govspeak_to_html(body) if body.present?
end
Expand Down
12 changes: 7 additions & 5 deletions app/views/govuk_publishing_components/component_guide/component_doc/_preview.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<div data-module="test-a11y" data-excluded-rules="<%= @component_doc.accessibility_excluded_rules %>">
<%= render "govuk_publishing_components/component_guide/component_doc/component", component_doc: @component_doc, example: example, preview_page: false %>
<div class="component-guide-preview component-guide-preview--violation" data-module="test-a11y-violation" data-content="Accessibility Issues"></div>
<div class="component-guide-preview component-guide-preview--warning" data-module="test-a11y-warning" data-content="Potential accessibility issues: need manual check"></div>
</div>
<% if component_doc.display_preview? %>
<div data-module="test-a11y" data-excluded-rules="<%= @component_doc.accessibility_excluded_rules %>">
<%= render "govuk_publishing_components/component_guide/component_doc/component", component_doc: @component_doc, example: example, preview_page: false %>
<div class="component-guide-preview component-guide-preview--violation" data-module="test-a11y-violation" data-content="Accessibility Issues"></div>
<div class="component-guide-preview component-guide-preview--warning" data-module="test-a11y-warning" data-content="Potential accessibility issues: need manual check"></div>
</div>
<% end %>

<% if component_doc.display_html? %>
<div class="component-guide-preview component-call component-highlight component-output" data-content="HTML OUTPUT">
Expand Down
1 change: 1 addition & 0 deletions app/views/govuk_publishing_components/components/docs/metadata.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ accessibility_criteria: |

shared_accessibility_criteria:
- link
display_preview: false
examples:
from_only:
data:
Expand Down