Skip to content
This repository

Document non-standard public methods #20

Closed
jzaefferer opened this Issue · 9 comments

3 participants

Jörn Zaefferer Scott González TJ VanToll
Jörn Zaefferer
Owner

To start, move most of Menu's method into a separate section labelled "Internals" or "Extending". Keep only refresh and widget-inherited methods in the regular "Methods" section.

Implementation wise, probably just keep <methods> (or create around method elements if it doesn't yet exist, and add another element for the other methods, reusing the same template for both.


autocomplete

  • _resizeMenu()
  • _renderMenu()
  • _renderItem()

dialog

  • _allowInteraction()

menu

  • _closeOnDocumentClick()

spinner

  • _uiSpinnerHtml()
  • _buttonHtml()
Scott González
Owner

We need to be careful about the wording. Labels like "internal" don't provide the meaning we want to express, but we don't currently have a good way to explain how our methods are divided. There's basically three levels:

  1. Methods that are exposed as .widget( method ).
  2. Methods that are not exposed as .widget( method ), but public API and stable.
  3. Methods that are private and may change or be removed without warning.
TJ VanToll
Collaborator

Proposed plan:

1) Add an "Extension" section to each widget.
2) Link to a learning article about extending UI widgets.
3) List methods that are extendable in said "Extension" section.

Jörn Zaefferer
Owner

@tjvantoll is this something you could start working on?

TJ VanToll
Collaborator

@tjvantoll is this something you could start working on?

Yeah, the learn article seems like a good starting point so I can write that.

TJ VanToll
Collaborator

1) Add an "Extension" section to each widget.

Pull: #177

2) Link to a learning article about extending UI widgets.

Pull: jquery/learn.jquery.com#427

3) List methods that are extendable in said "Extension" section.

We can add these as they come up. If you there very useful ones you guys can think of off the top of your heads I can add those.

Scott González

jquery/grunt-jquery-content@4698d74 adds support for documentating methods as extension points. @tjvantoll will be working on documenting the actual extension points.

TJ VanToll
Collaborator

http://learn.jquery.com/jquery-ui/widget-factory/extending-widgets/ is live as well.

@scottgonzalez @jzaefferer If you have specific methods you'd like to see documented as extension points please list them here.

Scott González

I put an initial list into the issue description, but we should probably have a discussion about the list.

TJ VanToll
Collaborator

Landed per #178.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.