Class: Primer::Truncate

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/truncate.rb

Overview

Use Truncate to shorten overflowing text with an ellipsis.

Constant Summary

Constants included from Status::Dsl

Status::Dsl::STATUSES

Constants included from ViewHelper

ViewHelper::HELPERS

Constants included from TestSelectorHelper

Primer::TestSelectorHelper::TEST_SELECTOR_TAG

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Instance Method Summary collapse

Methods included from JoinStyleArgumentsHelper

#join_style_arguments

Methods included from TestSelectorHelper

#add_test_selector

Methods included from FetchOrFallbackHelper

#fetch_or_fallback, #fetch_or_fallback_boolean, #silence_deprecations?

Methods included from ClassNameHelper

#class_names

Constructor Details

#initialize(inline: false, expandable: false, max_width: nil, **system_arguments) ⇒ Truncate

Returns a new instance of Truncate.

Examples:

Default

<div class="col-2">
  <%= render(Primer::Truncate.new(tag: :p)) { "branch-name-that-is-really-long" } %>
</div>

Inline

<%= render(Primer::Truncate.new(tag: :span, inline: true)) { "branch-name-that-is-really-long" } %>

Expandable

<%= render(Primer::Truncate.new(tag: :span, inline: true, expandable: true)) { "branch-name-that-is-really-long" } %>

Custom size

<%= render(Primer::Truncate.new(tag: :span, inline: true, expandable: true, max_width: 100)) { "branch-name-that-is-really-long" } %>

Parameters:

  • inline (Boolean) (defaults to: false) —

    Whether the element is inline (or inline-block).

  • expandable (Boolean) (defaults to: false) —

    Whether the entire string should be revealed on hover. Can only be used in conjunction with ‘inline`.

  • max_width (Integer) (defaults to: nil) —

    Sets the max-width of the text.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'app/components/primer/truncate.rb', line 26

def initialize(inline: false, expandable: false, max_width: nil, **system_arguments)
  @system_arguments = system_arguments
  @system_arguments[:tag] ||= :div
  @system_arguments[:classes] = class_names(
    @system_arguments[:classes],
    "css-truncate",
    "css-truncate-overflow" => !inline,
    "css-truncate-target" => inline,
    "expandable" => inline && expandable
  )
  @system_arguments[:style] = join_style_arguments(@system_arguments[:style], "max-width: #{max_width}px;") unless max_width.nil?
end

Instance Method Details

#call ⇒ Object 



39
40
41
 
# File 'app/components/primer/truncate.rb', line 39

def call
  render(Primer::BaseComponent.new(**@system_arguments)) { content }
end