From e53feba1fd3778e738ee0118fa9dc32c5f84a06e Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Fri, 14 Feb 2014 10:15:34 -0800 Subject: [PATCH] Add full example to header comment --- src/select-list-view.coffee | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/src/select-list-view.coffee b/src/select-list-view.coffee index a5e89d203..48308d026 100644 --- a/src/select-list-view.coffee +++ b/src/select-list-view.coffee @@ -2,8 +2,9 @@ EditorView = require './editor-view' fuzzyFilter = require('fuzzaldrin').filter -# Public: Provides a widget for users to make a selection from a list of -# choices. +# Public: Provides a view that renders a list of items with an editor that +# filters the items. Used by many packages such as the fuzzy-finder, +# command-palette, symbols-view and autocomplete. # # Subclasses must implement the following methods: # @@ -14,6 +15,20 @@ fuzzyFilter = require('fuzzaldrin').filter # # ```coffee # {SelectListView} = require 'atom' +# +# class MySelectListView extends SelectListView +# initialize: -> +# super +# @addClass('overlay from-top') +# @setItems(['Hello', 'World']) +# atom.workspaceView.append(this) +# @focusEditor() +# +# viewForItem: (item) -> +# "
  • #{item}
  • " +# +# confirmed: (item) -> +# console.log("#{item} was selected") # ``` module.exports = class SelectListView extends View @@ -237,6 +252,10 @@ class SelectListView extends View attach: -> @storeFocusedElement() + # Public: Focus the fuzzy filter editor. + focusEditor: -> + @editorView.focus() + storeFocusedElement: -> @previouslyFocusedElement = $(':focus')