Merge pull request #3 from cryogenian/autocomplete

autocomplete

Author: cryogenian

README.md

@@ -15,5 +15,8 @@ bower install purescript-ace-halogen
 ## Module documentation
 
 - [Ace.Halogen.Component](docs/Ace/Halogen/Component.md)
-- [Ace.Halogen.Component.Query](docs/Ace/Halogen/Component/Query.md)
-- [Ace.Halogen.Component.State](docs/Ace/Halogen/Component/State.md)
+
+
+## Notes
+
+Please add `Halogen.Component.Properties.key` or `Halogen.Component.Properties.Indexed.key` to wrappers of `Ace.Halogen.Component` if you need to use multiple editors on one page.

bower.json

@@ -2,7 +2,8 @@
   "name": "purescript-ace-halogen",
   "homepage": "https://github.com/slamdata/purescript-ace-halogen",
   "authors": [
-    "Gary Burgess <[email protected]>"
+    "Gary Burgess <[email protected]>",
+    "Maxim Zimaliev <[email protected]>"
   ],
   "description": "A Halogen component for the Ace editor",
   "keywords": [
@@ -22,7 +23,10 @@
     "test"
   ],
   "dependencies": {
-    "purescript-ace": "^0.8.0",
-    "purescript-halogen": "^0.5.6"
+    "purescript-halogen": "^0.5.6",
+    "purescript-refs": "^0.2.0",
+    "purescript-datetime": "^0.9.1",
+    "purescript-random": "^0.2.3",
+    "purescript-ace": "~0.10.0"
   }
 }

docs/Ace/Halogen/Component.md

@@ -1,17 +1,75 @@
 ## Module Ace.Halogen.Component
 
+#### `Autocomplete`
+
+``` purescript
+data Autocomplete
+  = Live
+  | Basic
+```
+
+#### `AceEffects`
+
+``` purescript
+type AceEffects e = (random :: RANDOM, now :: Now, ref :: REF, ace :: ACE, avar :: AVAR, dom :: DOM | e)
+```
+
+#### `AceQuery`
+
+``` purescript
+data AceQuery a
+  = Init HTMLElement a
+  | GetText (String -> a)
+  | SetText String a
+  | SetAutocomplete (Maybe Autocomplete) a
+  | SetCompleteFn (forall e. CompleteFn e) a
+  | GetEditor (Maybe Editor -> a)
+  | Quit a
+```
+
+Ace query algebra
+`Init` used internally to handle initialization of component
+`GetText` gets the current text value
+`SetText` alters the current text value
+`SetAutocomplete` sets autocomplete resume:
+   `Nothing` turns it off
+   `Just Basic` enables basic autocompletions (triggered by `Alt+Space` or `Ctrl + Space`)
+   `Just Live` enables live autocomplete
+`SetCompleteFn` sets function providing autocomplete variants.
+`GetEditor` returns ace editor instance handled by this component.
+`Quit` used internally to handle finalizing of component
+
+#### `CompleteFn`
+
+``` purescript
+type CompleteFn e = Editor -> EditSession -> Position -> String -> Aff (AceEffects e) (Array Completion)
+```
+
+Autocomplete function. Takes editor, session, text position and prefix
+returns array of possible completions in `Aff` monad.
+
+#### `AceState`
+
+``` purescript
+type AceState = { key :: Maybe String, editor :: Maybe Editor }
+```
+
+Ace component state
+`key` -- unique key of this instance
+`editor` -- ace editor instance wrapped by this component
+
 #### `aceComponent`
 
 ``` purescript
-aceComponent :: forall g eff. (MonadEff (ace :: ACE | eff) g) => Maybe String -> Component AceState AceQuery g
+aceComponent :: forall g eff. (MonadEff (AceEffects eff) g) => (Editor -> g Unit) -> Maybe Autocomplete -> Component AceState AceQuery g
 ```
 
 The Ace component.
 
 #### `aceConstructor`
 
 ``` purescript
-aceConstructor :: forall g p eff. (MonadEff (ace :: ACE | eff) g) => p -> Maybe String -> SlotConstructor AceState AceQuery g p
+aceConstructor :: forall g p eff. (MonadEff (AceEffects eff) g) => p -> (Editor -> g Unit) -> Maybe Autocomplete -> SlotConstructor AceState AceQuery g p
 ```
 
 A convenience function for creating a `SlotConstructor` for an Ace

docs/Ace/Halogen/Component/Query.md

@@ -9,6 +9,6 @@
     "rimraf": "^2.4.3"
   },
   "dependencies": {
-    "purescript": "^0.7.5"
+    "purescript": "^0.7.6"
   }
 }

docs/Ace/Halogen/Component/State.md

@@ -0,0 +1,13 @@
+// module Ace.Halogen.Component
+
+exports.completeFns = {value: {}};
+
+exports.initialized = {value: false};
+
+exports.focused = {value: ""};
+
+exports.dataset = function(node) {
+    return function() {
+        return node.dataset;
+    };
+};