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) -> +# "