Sha256: d3f74e84e1e85528c165fb2cfdfde938c23b50868d91d95605f144af66f7985f

Contents?: true

Size: 1.18 KB

Versions: 45

Compression:

Stored size: 1.18 KB

Contents

# frozen_string_literal: true

module Alchemy
  module Hints
    # Returns a hint
    #
    # To add a hint to a content pass +hint: true+ to the element definition in its element.yml
    #
    # Then the hint itself is placed in the locale yml files.
    #
    # Alternativly you can pass the hint itself to the hint key.
    #
    # == Locale Example:
    #
    #   # elements.yml
    #   - name: headline
    #     contents:
    #     - name: headline
    #       type: EssenceText
    #       hint: true
    #
    #   # config/locales/de.yml
    #     de:
    #       content_hints:
    #         headline: Lorem ipsum
    #
    # == Hint Key Example:
    #
    #   - name: headline
    #     contents:
    #     - name: headline
    #       type: EssenceText
    #       hint: Lorem ipsum
    #
    # @return String
    #
    def hint
      hint = definition["hint"]
      if hint == true
        Alchemy.t(name, scope: hint_translation_scope)
      else
        hint
      end
    end

    # Returns true if the element has a hint
    def has_hint?
      hint.present?
    end

    private

    def hint_translation_scope
      "#{self.class.model_name.to_s.demodulize.downcase}_hints"
    end
  end
end

Version data entries

45 entries across 45 versions & 1 rubygems

Version Path
alchemy_cms-5.3.5 lib/alchemy/hints.rb
alchemy_cms-5.3.4 lib/alchemy/hints.rb
alchemy_cms-5.3.3 lib/alchemy/hints.rb
alchemy_cms-5.3.2 lib/alchemy/hints.rb
alchemy_cms-5.3.1 lib/alchemy/hints.rb
alchemy_cms-5.3.0 lib/alchemy/hints.rb
alchemy_cms-5.2.7 lib/alchemy/hints.rb
alchemy_cms-5.2.6 lib/alchemy/hints.rb
alchemy_cms-5.1.10 lib/alchemy/hints.rb
alchemy_cms-5.0.10 lib/alchemy/hints.rb
alchemy_cms-5.2.5 lib/alchemy/hints.rb
alchemy_cms-5.1.9 lib/alchemy/hints.rb
alchemy_cms-5.0.9 lib/alchemy/hints.rb
alchemy_cms-5.2.4 lib/alchemy/hints.rb
alchemy_cms-5.1.8 lib/alchemy/hints.rb
alchemy_cms-5.0.8 lib/alchemy/hints.rb
alchemy_cms-5.0.7 lib/alchemy/hints.rb
alchemy_cms-5.1.7 lib/alchemy/hints.rb
alchemy_cms-5.2.3 lib/alchemy/hints.rb
alchemy_cms-5.1.6 lib/alchemy/hints.rb