dojox/fx/text.js

• Provides:

  • dojox.fx.text

• Requires:

  • dojo.fx in common
  • dojo.fx.easing in common

• dojox.fx.text._split

  • parameters:
    • args: (typeof Object)

      args.crop: Boolean - If true, pieces will be positioned relatively rather than absolutely
      args.text: String - Text to place inside the node (otherwise node.innerHTML is used)
      args.words: Boolean - If true, the text will be split into words rather than characters
      args.pieceAnimation: Function(piece, pieceCoords, nodeCoords, number, numPieces)
      - Returns either the dojo.Animation or an array of dojo.Animation objects for the piece;
      pieceCoords is the result of dojo.coords(piece, true);
      nodeCoords is the result of dojo.coords(args.node, true);
      number is the piece's position in the array of pieces, and numPieces is the array.length

  • returns

    dojo.Animation

  • summary

    Split a block of text into words or letters

  • description

    Returns an animation that will split the node into a grid
    of pieces that move independently.
    
    NOTE:
    In some rendering engines, the text will appear to "jump" from its initial position
    when the animation begins.	To work around this bug, enclose the node's text in a <p> or <div>.

  • type

    Function

• dojox.fx.text.explode

  • parameters:
    • args: (typeof Object)

      args.crop: Boolean - If true, pieces will be positioned relatively rather than absolutely
      args.words: Boolean - If true, text will be split into words rather than characters
      args.random: Float - If set, pieces fly to random distances, for random durations,
      and in slightly random directions. The value defines how much
      randomness is introduced.
      args.distance: Float - Multiplier for the distance the pieces fly (even when random)
      args.fade: Boolean - If true, pieces fade out while in motion (default is true)
      args.fadeEasing: Function - If args.fade is true, the fade animations use this easing function
      args.unhide: Boolean - If true, the animation is reversed
      args.sync: Boolean - If args.unhide is true, all the pieces converge at the same time
      (default is true)

  • returns

    dojo.Animation

  • summary

    Explode a block of text into words or letters

  • description

    Returns an animation that will split the text into a spans
    of words or characters that fly away from the center.

  • type

    Function

• dojox.fx.text.converge

  • parameters:
    • args: (typeof Object)
  • type

    Function

• dojox.fx.text.disintegrate

  • parameters:
    • args: (typeof Object)

      args.crop: Boolean - If true, pieces will be positioned relatively rather than absolutely
      args.words: Boolean - If true, text will be split into words rather than characters
      args.interval: Float - The number of milliseconds between each piece's animation
      args.distance: Float - The number of the node's heights to drop (default is 1.5)
      args.fade: Boolean - If true, pieces fade out while in motion (default is true)
      args.random: Float - If set, pieces fall in random order. The value defines how much
      randomness is introduced
      args.reverseOrder: Boolean - If true, pieces animate in reversed order
      args.unhide: Boolean - If true, the peices fall from above and land in place

  • returns

    dojo.Animation

  • summary

    Split a block of text into words or letters and let them fall

  • description

    Returns an animation that will split the text into spans of words
    or characters that drop.

  • type

    Function

• dojox.fx.text.build

  • parameters:
    • args: (typeof Object)
  • type

    Function

• dojox.fx.text.blockFadeOut

  • parameters:
    • args: (typeof Object)

      args.words: Boolean - If true, text will be split into words rather than characters
      args.interval: Float - The number of milliseconds between each piece's animation (default is 0)
      args.random: Float - If true, pieces have a random delay. The value defines how much
      randomness is introduced
      args.reverseOrder: Boolean - If true, pieces animate in reversed order
      args.unhide: Boolean - If true, the animation is reversed

  • returns

    dojo.Animation

  • summary

    Split a block of text into words or letters and fade them

  • description

    Returns an animation that will split the text into spans of words
    or characters that fade in or out.

  • type

    Function

• dojox.fx.text.blockFadeIn

  • parameters:
    • args: (typeof Object)
  • type

    Function

• dojox.fx.text.backspace

  • parameters:
    • args: (typeof Object)

      args.interval: Float - The number of milliseconds between each piece's animation
      (default is determined by text length and args.duration);
      args.wordDelay: Integer - The number of milliseconds between each word
      (only effective when args.unhide = true)
      args.fixed: Boolean - If true, only style.opacity changes; otherwise, style.display
      changes between none and inline, adding realism (default = false)
      args.random: Float - If true, pieces have a random delay. The value defines how much
      randomness is introduced (only effective when args.unhide = true)
      args.unhide: Boolean - If true, the animation is reversed

  • returns

    dojo.Animation

  • summary

    Split a block of text into words or letters and backspace them in sequence

  • description

    Returns an animation that will split the text into spans of words
    or characters that appear as if they were being backspaced (or typed) in real-time.

  • type

    Function

• dojox.fx.text.type

  • parameters:
    • args: (typeof Object)
  • type

    Function

• dojox.fx.text

  • type

    Object

• dojox.fx

  • type

    Object

• dojox

  • type

    Object