Opened 10 years ago

Closed 9 years ago

#4418 closed (fixed)

Add media descriptions to newforms widgets

Reported by: Russell Keith-Magee Owned by: Russell Keith-Magee
Component: Forms Version: master
Severity: Keywords: media css javascript
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: yes
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

A newforms widget currently defines the way to render a user interface input element. However, in order to make interesting input elements, you also need other media - i.e., Javascript and CSS. These requirements can be defined on a per-widget basis (a Date field requires a Calendar widget; the calendar widget requires media/calendar.js and media/calendar.css).

At present, there is no easy way to:

  1. identify what media is required to display a form
  2. identify and eliminate any duplicate media requirements, e.g., a base css file required by two different widgets on a form.

newforms-admin has some hand rolled functionality to determine Javascript requirements for a page. This ticket describes a more general solution that could be applied to any widget, and therefore to any form.

It involves adding a meta-class to Widget that processes a 'Media' inner class; this inner class is turned into a 'Media' object. Media objects can be printed (yielding <link> and <script> statements). Media objects can also be added, so media from one widget can be added to another widget, yielding the union of required media.

Forms are also modified; you can interrogate form.media to find out the union of all CSS and JavaScript required by a given form.

Discussed in detail here:
http://groups.google.com/group/django-developers/browse_thread/thread/58fc9cab819c08b9/af54bb9c638fede7#af54bb9c638fede7

Attachments (5)

media.diff (9.8 KB) - added by Russell Keith-Magee 10 years ago.
Adds a Media descriptor to newforms widgets
media2.diff (10.7 KB) - added by Russell Keith-Magee 10 years ago.
Revised media patch, to address inheritance issues.
media3.diff (16.3 KB) - added by Russell Keith-Magee 9 years ago.
Media descriptors for newforms, v3; against [5636]
newforms-admin-media.diff (27.2 KB) - added by Russell Keith-Magee 9 years ago.
Media descriptors for newforms-admin; against [5636]
newforms-admin-media.5651.diff (43.1 KB) - added by Russell Keith-Magee 9 years ago.
Improved media descriptors for newforms-admin; against [5651]

Download all attachments as: .zip

Change History (8)

Changed 10 years ago by Russell Keith-Magee

Attachment: media.diff added

Adds a Media descriptor to newforms widgets

comment:1 Changed 10 years ago by Russell Keith-Magee

Owner: changed from Adrian Holovaty to Russell Keith-Magee
Triage Stage: UnreviewedAccepted

comment:2 Changed 10 years ago by Russell Keith-Magee

Has patch: set
Needs documentation: set

Changed 10 years ago by Russell Keith-Magee

Attachment: media2.diff added

Revised media patch, to address inheritance issues.

Changed 9 years ago by Russell Keith-Magee

Attachment: media3.diff added

Media descriptors for newforms, v3; against [5636]

Changed 9 years ago by Russell Keith-Magee

Attachment: newforms-admin-media.diff added

Media descriptors for newforms-admin; against [5636]

Changed 9 years ago by Russell Keith-Magee

Improved media descriptors for newforms-admin; against [5651]

comment:3 Changed 9 years ago by Russell Keith-Magee

Resolution: fixed
Status: newclosed

(In [5926]) newforms-admin: Fixed #4418 -- Added the ability for widgets, forms, and Admin declarations to have media definitions.

Note: See TracTickets for help on using tickets.
Back to Top