sifr(options) function

Category: Attributes/Changing Contents

Replace the HTML contents of every matched element with a sIFR equivelent. This property is not available on XML documents (although it will work for XHTML documents).

Returns

  • jQuery

Parameters

  • options (Object): A set of key/value pairs that configure the sIFR replacement. All options are optional. A default can be set for any option with $.sifr(options).

Options

  • build (String or Integer): For sIFR 3 fonts a build parameter usually needs to be passed for the sIFRing to occur.
  • color (String): If set, the sIFR function will ignore the natural color of each of the matched elements and use this name, hex value, or rgb value instead.
  • content (String): If set, the sIFR function will ignore the contents of each of the matched elements and use this instead.
  • css (Object): The object based stylesheet containing key/value pairs to set as style properties for the sIFR element.
  • cursor (String): The desired cursor type when the mouse is over the sIFR element.
  • debug (Boolean): By default, the original data is given 0 opacity (i.e. this is set to true by default). If you want to see the sIFR replacement on top of the original HTML, which is useful for debugging and better configuring alignment, set this option to false.
  • delayRun (Boolean): By default, there is no delay (i.e. this is set to false by default) before the sIFR is executed, but due to Flash versions older than 9,0,115 under IE incorrectly approaching the Flash movie, breaking ExternalInterface, sIFR has this workaround.
  • events (Boolean): I don't know what this does; it's an undocumented sIFR feature?
  • fitExactly (Boolean): I don't know what this does; it's an undocumented sIFR feature?
  • fixHover (Boolean): Enables or disables a workaround to fix a problem where the hover state of a link in the Flash movie would not return to normal.
  • font (String): The sIFR font file name to be used, otherwise taken from the first available font in the font family property of each of the matched elements. Opera does not support the CSS method.
  • fontSize (String): If set, the sIFR function will ignore the natural font size of matched elements and use this instead.
  • fontWeight (String): If set, the sIFR function will ignore the natural font weight of matched elements and use this instead.
  • forceSingleLine (Boolean): Forces the text to be displayed on a single line.
  • gridFitType (String): See Livedoc 2747. If the text is right aligned, subpixel will be used by default, otherwise "pixel" will be used.
  • height (String or Integer): If set, the sIFR function will ignore the natural height of the text of the matched elements and use this instead.
  • hoverColor (String): The name, hex value, or rgb value of the color for the sIFR element's anchor tags on mouse over.
  • lineHeight (String or Integer): If set, the sIFR function will ignore the natural line height of matched elements and use this instead.
  • linkColor (String): The name, hex value, or rgb value of the color for the sIFR element's anchor tags.
  • opacity (Integer): Sets the opacity of the sIFR element.
  • over (Integer): Increases or decreases the overflow of the sIFR element.
  • overX (Integer): Increases or decreases the overflow of the sIFR element to the left and right.
  • overY (Integer): Increases or decreases the overflow of the sIFR element on the top and bottom.
  • path (String): The directory path of the sIFR font file being used.
  • preventWrap (Boolean): Tries to disable word wrap inside the Flash movie, but doesn't always work so well and is not the same as forceSingeLine.
  • resizable (Boolean): By default, the sIFR elements will not resize themselves on window resize (i.e. this is set to false by default). If you want the sIFR elements to do this, which is useful for pages with dynamic widths, set this option to true.
  • style (Object): The key/value pairs to set as style properties for the sIFR element.
  • textAlign (String): If set, the sIFR function will ignore the natural text alignment of matched elements and use this instead.
  • textTransform (String): If set, the sIFR function will ignore the text transformation style of each of the matched elements and use this instead.
  • version (String): The version of the sIFR font being used. The jQuery sIFR plugin supports versions 2 and 3.
  • width (String or Integer): If set, the sIFR function will ignore the natural width of the text of the matched elements and use this instead.
  • zoom (Integer): Increases and decreases the size of the sIFR text.