Module Haml::Filters
In: lib/haml/sass_rails_filter.rb
lib/haml/filters.rb

The module containing the default Haml filters, as well as the base module, {Haml::Filters::Base}.

@see Haml::Filters::Base

Methods

Classes and Modules

Module Haml::Filters::Base
Module Haml::Filters::Cdata
Module Haml::Filters::Css
Module Haml::Filters::Erb
Module Haml::Filters::Escaped
Module Haml::Filters::Javascript
Module Haml::Filters::Plain
Module Haml::Filters::PrecompiledTiltFilter
Module Haml::Filters::Preserve
Module Haml::Filters::Ruby
Module Haml::Filters::TiltFilter
Class Haml::Filters::SassRailsTemplate
Class Haml::Filters::ScssRailsTemplate

Attributes

defined  [R]  @return [{String => Haml::Filters::Base}] a hash mapping filter names to
  classes.

Public Instance methods

Loads an external template engine from [Tilt](github.com/rtomayko/tilt) as a filter. This method is used internally by Haml to set up filters for Sass, SCSS, Less, Coffeescript, and others. It‘s left public to make it easy for developers to add their own Tilt-based filters if they choose.

@return [Module] The generated filter. @param [Hash] options Options for generating the filter module. @option options [Boolean] :precompiled Whether the filter should be

  precompiled. Erb, Nokogiri and Builder use this, for example.

@option options [Class] :template_class The Tilt template class to use,

  in the event it can't be inferred from an extension.

@option options [String] :extension The extension associated with the

  content, for example "markdown". This lets Tilt choose the preferred
  engine when there are more than one.

@option options [String,Array<String>] :alias Any aliases for the filter.

  For example, :coffee is also available as :coffeescript.

@option options [String] :extend The name of a module to extend when

  defining the filter. Defaults to "Plain". This allows filters such as
  Coffee to "inherit" from Javascript, wrapping its output in script tags.

@since 4.0

Removes a filter from Haml. If the filter was removed, it returns the that was remove Module upon success, or nil on failure. If you try to redefine a filter, Haml will raise an error. Use this method first to explicitly remove the filter before redefining it. @return Module The filter module that has been removed @since 4.0

[Validate]