angular-dragdrop/index.html at master · martinraison/angular-dragdrop · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
<!DOCTYPE html>
<html ng-app="app">
<head>
    <title>Angular DragDrop</title>
    <link rel="stylesheet" href="css/bootstrap.css"/>
    <link rel="stylesheet" href="css/styles.css"/>
    <link rel="stylesheet" href="http://yandex.st/highlightjs/7.3/styles/github.min.css">
    <script src="http://yandex.st/highlightjs/7.3/highlight.min.js"></script>
    <script data-require="angular.js@1.1.x" src="//ajax.googleapis.com/ajax/libs/angularjs/1.1.5/angular.min.js"
            data-semver="1.1.5"></script>
    <script src="http://pc035860.github.io/angular-highlightjs/angular-highlightjs.min.js"></script>
</head>
<body>

<header class="navbar navbar-default navbar-fixed-top" role="banner">
    <div class="container">
        <div class="navbar-header">
            <a href="#" class="navbar-brand">Angular DragDrop</a>
        </div>
        <!--<nav class="collapse navbar-collapse" role="navigation">
            <ul class="nav navbar-nav">
                <li class="active">
                    <a href="">Configurable Options</a>
                </li>
                <li>
                    <a href="">Examples</a>
                </li>
            </ul>
        </nav>-->
    </div>
</header>
<a class="ribbon" href="https://github.com/ganarajpr/angular-dragdrop"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
<div class="jumbotron">
    <div class="container">
        <h1>Angular Drag and Drop</h1>

        <p>A Native ( without jquery ) Drag and Drop directive for <a href="http://www.angularjs.org">AngularJS</a>
            using HTML5 Drag and Drop</p>
        <iframe src="http://ghbtns.com/github-btn.html?user=ganarajpr&repo=angular-dragdrop&type=watch&count=true"
                allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
        <iframe src="http://ghbtns.com/github-btn.html?user=ganarajpr&repo=angular-dragdrop&type=fork&count=true"
                allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
    </div>


</div>
<div class="container content">
    <h2>Directives</h2>
    <hr>

    <h3 class="text-info"><em>ui-draggable</em></h3>

    <p>
        directive in module <em>ngDragDrop</em>
    </p>

    <p>The <code>ui-draggable</code> attribute tells Angular that the element is draggable. <code>ui-draggable</code>
        takes an expression as the attribute value. The expression should evaluate to either <code>true</code> or <code>false</code>.
        You can toggle the draggability of an element using this expression.
    </p>


    <h3 class="heading"><strong>Additional Attributes</strong></h3>

    <h4 class="text-info"><em>drag</em></h4>

    <p>The <code>drag</code> property is used to assign the data that needs to be passed along with the dragging
        element.</p>
    <hr>
    <h4 class="text-info"><em>on-drop-success</em></h4>

    <p>The <code>on-drop-success</code> attribute takes a function. We can consider this to be an on-drop-success
        handler function.
        This can be useful if you need to do some post processing after the dragged element is dropped successfully on
        the drop site.

    <div>
        <strong>NOTE</strong> : This callback function is only called when the drop succeeds.
    </div>
    You can request the <code>drag-end</code> event ( very similiar to requesting the click event in
    <code>ng-click</code> )
    by passing <code>$event</code> in the event handler.
    </p>

    <hr>
    <h3 class="heading"><strong>Usage</strong></h3>

    <p>

    <div hljs>
        <ANY ui-draggable="{expression}"
             drag="dragData"
             on-drop-success="onDropSuccessHandler($event)"
             drag-channel="mydropchannel">...
        </ANY>
    </div>
    </p>

    <h3 class="heading"><strong>Details</strong></h3>

    <p>
    <table class="table table-bordered">
        <thead>
        <tr>
            <td>Param</td>
            <td>Type</td>
            <td>Details</td>
        </tr>
        </thead>
        <tbody>
        <tr>
            <td>ui-draggable</td>
            <td><label class="text-muted">expression</label></td>
            <td><a target="_blank" href="http://docs.angularjs.org/guide/expression">Expression</a> that should be
                evaluated. The given expression should resolve to true or false.
            </td>
        </tr>
        <tr>
            <td>drag</td>
            <td><label class="text-muted">variable</label></td>
            <td>Takes any JSON convertable <code>$scope</code> variable.</td>
        </tr>
        <tr>
            <td>on-drop-success</td>
            <td><label class="text-muted">function</label></td>
            <td>Takes any <code>$scope</code> function. Can also pass <code>$event</code>.</td>
        </tr>
        <tr>
            <td>drag-channel</td>
            <td><label class="text-muted">string</label></td>
            <td>Takes a string that can be used as the channel name for the dragging operation.
                Default channel is <code>"defaultchannel"</code>
            </td>
        </tr>
        </tbody>
    </table>
    </p>
    <hr>

    <h3 class="heading"><strong>Events</strong></h3>

    <p>On start of dragging an Angular Event <code>ANGULAR_DRAG_START</code> is dispatched from the
        <code>$rootScope</code>. The event also carries
        carries the information about the channel in which the dragging has started.
    </p>

    <p>On end of dragging an Angular Event <code>ANGULAR_DRAG_END</code> is dispatched from the <code>$rootScope</code>.
        The event also carries
        carries the information about the channel in which the dragging has started.
    </p>

    <hr>

    <h3 class="text-info"><em>ui-on-drop</em></h3>

    <p>
        directive in module <em>ngDragDrop</em>
    </p>

    <p>The <code>ui-on-drop</code> attribute tells Angular that the element is a drop site. <code>ui-on-drop</code>
        takes a function as the attribute value. The function will be called when a valid dragged element is dropped in
        that location.
        A valid dragged element is one which has the same channel as the drop location.

    <div>
        <strong>NOTE</strong> : This callback function is only called when the drop succeeds.
    </div>
    The <code>ui-on-drop</code> callback can request additional parameters. The data that is dragged is available to the
    callback as <code>$data</code>. Apart from this the drop event is exposed as <code>$event</code>.
    </p>
    <h3 class="heading"><strong>Additional Attributes</strong></h3>

    <h4 class="text-info"><em>drop-channel</em></h4>

    <p>The channel that the drop site accepts. The dragged element should have the same channel as this drop site for it
        to be
        droppable at this location.</p>

    <hr>

    <h4 class="text-info"><em>drag-enter-class</em></h4>

    <p>The class that will be added to the the droppable element when a dragged element ( which is droppable )
        enters the drop location. The default value for this is <code>on-drag-enter</code></p>

    <hr>
    <h3 class="heading"><strong>Usage</strong></h3>

    <p>

    <div hljs>
        <ANY ui-on-drop="onDrop($data,$event)" drop-channel="mydropchannel" drag-enter-class="dragEnter">...</ANY>
    </div>
    </p>

    <h3 class="heading"><strong>Details</strong></h3>

    <p>
    <table class="table table-bordered">
        <thead>
        <tr>
            <td>Param</td>
            <td>Type</td>
            <td>Details</td>
        </tr>
        </thead>
        <tbody>
        <tr>
            <td>ui-on-drop</td>
            <td><label class="text-muted">function</label></td>
            <td>Takes any <code>$scope</code> function. Can also pass <code>$event</code> and <code>$data</code>.
            </td>
        </tr>
        <tr>
            <td>drop-channel</td>
            <td><label class="text-muted">expression</label></td>
            <td>The channel on which the drop has to listen for drag events.</td>
        </tr>
        <tr>
            <td>drag-enter-class</td>
            <td><label class="text-muted">string</label></td>
            <td>A class name that will be put on the droppable element when the dragged objects enters its boundaries.</td>
        </tr>
        </tbody>
    </table>
    </p>
    <hr>
    <h3 class="heading"><strong>Demo</strong></h3>
    <iframe style="width: 100%; height: 500px" src="http://embed.plnkr.co/y6zNAEffJneAsfKADnBK" frameborder="0" allowfullscreen="allowfullscreen"></iframe>


</div>
<footer class="navbar navbar-default navbar-fixed-bottom"></footer>
<script type="text/javascript" src="js/app.js"></script>

<script>
    (function (i, s, o, g, r, a, m) {
        i['GoogleAnalyticsObject'] = r;
        i[r] = i[r] || function () {
            (i[r].q = i[r].q || []).push(arguments)
        }, i[r].l = 1 * new Date();
        a = s.createElement(o),
                m = s.getElementsByTagName(o)[0];
        a.async = 1;
        a.src = g;
        m.parentNode.insertBefore(a, m)
    })(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');

    ga('create', 'UA-44888767-1', 'ganarajpr.github.io');
    ga('send', 'pageview');

</script>
</body>
</html>