README 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. -------------------------------------------------------------------------------
  2. dojox.widget Collection
  3. -------------------------------------------------------------------------------
  4. Version 1.0
  5. Release date: 10/31/2007
  6. -------------------------------------------------------------------------------
  7. Project state:
  8. [Calendar] experimental
  9. [CalendarFx] experimental
  10. [ColorPicker] beta
  11. [Dialog] experimental
  12. [FeedPortlet] experimental
  13. [FilePicker] experimental
  14. [FisheyeList] experimental
  15. [FisheyeLite] beta
  16. [Iterator] experimental
  17. [Loader] experimental
  18. [Pager] experimental
  19. [Portlet] experimental
  20. [PlaceholderMenuItem] experimental
  21. [Roller] experimental
  22. [RollingList] experimental
  23. [SortList] experimental
  24. [Toaster] experimental
  25. [Wizard] experimental
  26. [AnalogGauge] experimental
  27. [BarGauge] experimental
  28. [Standby] experimental
  29. -------------------------------------------------------------------------------
  30. Credits:
  31. [Calendar] Shane O'Sullivan
  32. [CalendarFx] Shane O'Sullivan
  33. [ColorPicker] Peter Higgins (dante)
  34. [Dialog] Peter Higgins (dante)
  35. [FeedPortlet] Shane O'Sullivan
  36. [FilePicker] Nathan Toone (toonetown)
  37. [FisheyeList] Karl Tiedt (kteidt)
  38. [FisheyeLite] Peter Higgins (dante)
  39. [Iterator] Alex Russell (slightlyoff)
  40. [Loader] Peter Higgins (dante)
  41. [Pager] Nikolai Onken (nonken), Peter Higgins (dante);
  42. [PlaceholderMenuItem] Nathan Toone (toonetown)
  43. [Portlet] Shane O'Sullivan
  44. [Roller] Peter Higgins (dante)
  45. [RollingList] Nathan Toone (toonetown)
  46. [SortList] Peter Higgins (dante)
  47. [Toaster] Adam Peller (peller)
  48. [Wizard] Peter Higgins (dante)
  49. [AnalogGauge] Benjamin Schell (bmschell) CCLA
  50. [BarGauge] Benjamin Schell (bmschell) CCLA
  51. [Standby] Jared Jurkiewicz (jaredj) CCLA
  52. [UpgradeBar] Mike Wilcox (mwilcox), Revin Guillen
  53. -------------------------------------------------------------------------------
  54. Project description
  55. This is a collection of standalone widgets for use in
  56. your website. Each individual widget is independent
  57. of the others.
  58. -------------------------------------------------------------------------------
  59. Dependencies:
  60. Each widget has it's own requirements and dependencies.
  61. Most inherit from dijit base-classes such as dijit._Widget,
  62. dijit._Templated, etc ... So we will assume the availablility
  63. of dojo (core), and dijit packages.
  64. Each individual component stores resources in a folder that shares
  65. a name with the Widget. For instance:
  66. the Dialog lives in
  67. dojox/widget/Dialog.js ...
  68. and the folder:
  69. dojox/widget/Dialog/ contains a 'Dialog.css', the required
  70. styles for that particular widget. All required templates and
  71. images reside in the folder.
  72. This differs slightly from the rest of DojoX in that each other
  73. project uses a shared resources/ folder in the project folder,
  74. though uses the same naming convention for stylesheets and templates.
  75. eg:
  76. dojox/layout/resources/ExpandoPane.css
  77. dojox.layout.ExpandoPane
  78. -------------------------------------------------------------------------------
  79. Documentation
  80. Please refer to the API-tool, or in-line documentation. All of these
  81. widgets are of varying use, quality, and documentation completion.
  82. -------------------------------------------------------------------------------
  83. Installation instructions
  84. These are standalone Widgets, so putting the [widget].js file
  85. in your dojox/widget folder, and copying any files in the
  86. /dojox/widget/[widget]/ folder as supplements/templates/etc
  87. should be all you need to do.
  88. eg: FisheyeList:
  89. /dojox/widget/FisheyeList.js
  90. /dojox/widget/FisheyeList/FisheyeList.css
  91. should be all you need to use the Fisheye widget.
  92. you can safely import the whole widget project into your
  93. dojox/ root directory from the following SVN url:
  94. http://svn.dojotoolkit.org/src/dojox/trunk/widget
  95. -------------------------------------------------------------------------------
  96. Other Notes (Brief widget list):
  97. * ColorPicker - An HSV ColorPicker intended to be a drop down
  98. * Calendar - An extension on the dijit._Calendar providing a different UI
  99. * CalendarFx - additional mixable FX for transitions in dojox.widget.Calendar
  100. * Dialog - An extended version of dijit.Dialog with man options and transition.
  101. * FilePicker - a widget for browsing server-side file systems (can use
  102. dojox.data.FileStore as backend store)
  103. * FisheyeList - the classic FishEye Picker (abandoned)
  104. * FisheyeLite - A partial replacement for the FisheyeList - serious performance
  105. gains, and entirely more extensible in that it simply animates defined
  106. properties, relying on the natural styling as a foundation.
  107. * Iterator - Basic array and data store iterator class
  108. * Loader - an experimental Class that listens to XHR
  109. connections in the background, and displays
  110. a loading indicator. Loader will be removed in 1.3, and is (abandoned).
  111. * PlaceholderMenuItem - a menu item that can be used to inject other menu
  112. items at a given location. Extends dijit.Menu directly.
  113. * Roller - A component to show many lines of text in a single area, rotating
  114. through the options available. Also provides RollerSlide, an extension
  115. to the stock fading roller to add a slide animation to the transition.
  116. * RollingList - A component of the FilePicker widget
  117. * SortList - a degradable UL with a fixed header, scrolling,
  118. and sorting. Can be the direct descendant of a
  119. LayoutContainer and will size to fit.
  120. * Toaster - a messaging system to display unobtrusive
  121. alerts on screen.
  122. * Wizard - a StackContainer with built-in navigation to
  123. ease in the creation of 'step-based' content.
  124. Requires dojo >= 1.1
  125. * AnalogGauge - an analog style customizable gauge for displaying values in an
  126. animated fashion and with multiple indicators. Supports easings for
  127. indicator animations, transparent overlays, etc. Very flexible.
  128. Requires dojo >= 1.3
  129. * BarGauge - a bar style gauge for displaying values in an animated fashion
  130. and with multiple indicators. Supports easings for indicator animations,
  131. etc. Very flexible.
  132. Requires dojo >= 1.3
  133. * Standby - a 'blocker' style widget to overlay a translucent div + image over a DOM node/widget to indicate busy.
  134. Overlay color, image, and alt text can all be customized.
  135. Requires dojo >= 1.3
  136. * UpgradeBar - Displays the "yellow bar" at the top of a page to indicate the user
  137. needs to upgrade their browser or a plugin
  138. Requires dojo >= 1.3