@cocreate/api 1.10.13 → 1.10.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/FUNDING.yml +3 -3
- package/.github/workflows/automated.yml +95 -95
- package/.github/workflows/manual.yml +44 -44
- package/CHANGELOG.md +1436 -1429
- package/CONTRIBUTING.md +96 -96
- package/CoCreate.config.js +26 -26
- package/LICENSE +660 -660
- package/README.md +85 -85
- package/demo/client.js +38 -38
- package/demo/index.html +60 -52
- package/docs/form.html +216 -216
- package/docs/index.html +241 -241
- package/docs/module.html +206 -206
- package/docs/server.html +217 -217
- package/package.json +9 -9
- package/release.config.js +21 -21
- package/src/client.js +189 -189
- package/src/index.js +13 -13
- package/src/server.js +108 -108
- package/webpack.config.js +84 -84
package/docs/module.html
CHANGED
|
@@ -1,206 +1,206 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
|
|
4
|
-
<head>
|
|
5
|
-
<meta charset="utf-8">
|
|
6
|
-
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
7
|
-
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
8
|
-
<title>CoCreate-api module Documentation | CoCreateJS </title>
|
|
9
|
-
<link rel="icon" type="image/png" sizes="32x32" href="https://cocreate.app/images/favicon.ico">
|
|
10
|
-
<meta name="description" content="An api helper component in vanilla javascript to setup thirdparty api intergrations. Apis can be accessible using HTML5 attributes and/or JavaScript API" />
|
|
11
|
-
<meta name="keywords" content="drag and drop, colaboration, dnd utility, drag and drop utility" />
|
|
12
|
-
<meta name="robots" content="index,follow" />
|
|
13
|
-
<meta property="og:image" content="https://cdn.cocreate.app/docs/api.png">
|
|
14
|
-
|
|
15
|
-
<!-- CoCreate CSS -->
|
|
16
|
-
<link rel="stylesheet" href="https://cdn.cocreate.app/latest/CoCreate.min.css" type="text/css" />
|
|
17
|
-
<link rel="stylesheet" href="/docs/index.css" collection="files" document_id="60888216117c640e7596303f" name="src" type="text/css" save="true" />
|
|
18
|
-
<link rel="manifest" href="/manifest.webmanifest">
|
|
19
|
-
</head>
|
|
20
|
-
|
|
21
|
-
<body>
|
|
22
|
-
<nav class="nav display:flex align-items:center left:0px background:whitesmoke padding-top:10px padding-bottom:10px" content_id="content" scroll="sticky-nav,hide-nav" scroll-up="10" scroll-down="10" collection="files" document_id="60395ef42b3ac232657040fd" name="src">
|
|
23
|
-
</nav>
|
|
24
|
-
<sidenav id="menuL" class="position:fixed top:0px left:0px overflow:hidden background:whitesmoke height:100vh width:0px width:300px@xl" resizable resize-target="[content_id='content']" resize-property="margin-left" resize-value="width">
|
|
25
|
-
<menu collection="files" document_id="603717b07de7fb350ae9fec8" name="src"></menu>
|
|
26
|
-
<div resize="right"></div>
|
|
27
|
-
</sidenav>
|
|
28
|
-
<main class="padding-top:15px padding:15px@lg@xl" content_id="content" id="CoCreate-api-module">
|
|
29
|
-
<div class="display:flex flex-wrap:wrap justify-content:space-between position:relative margin:10px">
|
|
30
|
-
<div class="display:flex align-items:center">
|
|
31
|
-
<h2>CoCreate-api modules</h2>
|
|
32
|
-
</div>
|
|
33
|
-
<a href="https://github.com/CoCreate-app/CoCreate-dnd" target="_blank" class=""><i class="height:20px fill:#505050" src="/assets/svg/github.svg"></i></a>
|
|
34
|
-
</div>
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
client component and server side for api processing.</
|
|
38
|
-
<div id="api-section" class="display:flex flex-wrap:wrap">
|
|
39
|
-
<div class="flex-grow:1 width:400px width:300px@xs padding:0px_10px margin-top:60px">
|
|
40
|
-
|
|
41
|
-
<div id="api-install" class="border-bottom:1px_solid_lightgrey" scroll scroll-intersect="color:dodgerblue" scroll-target="#api-install-section">
|
|
42
|
-
<span class="display:flex align-items:center width:fit-content" hover="display:block!important" hover-target=
|
|
43
|
-
<h2 class="padding:5px_0px">Install</h2>
|
|
44
|
-
<a class="margin-left:10px display:none" href="#api-install"><i class="height:20px fill:#505050" src="/assets/svg/link.svg"></i></a>
|
|
45
|
-
</span>
|
|
46
|
-
</div>
|
|
47
|
-
|
|
48
|
-
<p class="padding:10px_0px line-height:1.5">
|
|
49
|
-
<pre><code class="language-bash">npm i @cocreate/api</code></pre>
|
|
50
|
-
</p>
|
|
51
|
-
<p class="padding:10px_0px line-height:1.5">Or you can use cdn link:</p>
|
|
52
|
-
<pre><code class="language-html"><script>https://cdn.cocreate.app/api/latest/CoCreate-api.min.js</script></code></pre>
|
|
53
|
-
|
|
54
|
-
<div>
|
|
55
|
-
<h2 id="api-dependencies" hover="display:block" hover-target="" class="border-bottom:1px_solid_lightgrey margin-top:80px padding:5px_0px">Dependencies components</h2>
|
|
56
|
-
<a class="display:none" href="#api-dependencies"><i class="height:20px fill:#505050" src="/assets/svg/link.svg"></i></a>
|
|
57
|
-
</div>
|
|
58
|
-
<p class="padding:10px_0px line-height:1.5">
|
|
59
|
-
<strong>CoCreate.js</strong>,
|
|
60
|
-
<strong>CoCreate-api.js</strong>,
|
|
61
|
-
</p>
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
<div>
|
|
65
|
-
<h2 id="api-development" hover="display:block" hover-target="" class="border-bottom:1px_solid_lightgrey margin-top:80px padding:5px_0px">Development Guide</h2>
|
|
66
|
-
<a class="display:none" href="#api-development"><i class="height:20px fill:#505050" src="/assets/svg/link.svg"></i></a>
|
|
67
|
-
</div>
|
|
68
|
-
|
|
69
|
-
<h3 class="margin-top:20px padding:5px_0px">1. Rules</h3>
|
|
70
|
-
<h4>(1). Module should be CoCreate-{module_id}.js</h4>
|
|
71
|
-
<pre><code class="language-javascript">Ex: CoCreate-stripe.js</code></pre>
|
|
72
|
-
<h4>(2). Module should include the actions that has unique name</h4>
|
|
73
|
-
<h4>(3). Module id and the endpoint is same.</h4>
|
|
74
|
-
<h4>(4). Action function name should be "action_{action_name}"</h4>
|
|
75
|
-
<h4>(5). Pre-processing function name should be "pre_{action_name}"</h4>
|
|
76
|
-
<h4>(6). Register module</h4>
|
|
77
|
-
<pre><code class="language-javascript">Ex: CoCreateApi.register(CoCreateStripe.id, CoCreateStripe);</code></pre>
|
|
78
|
-
|
|
79
|
-
<p class="padding:10px_0px line-height:1.5">
|
|
80
|
-
Stripe modules case's example
|
|
81
|
-
<pre><code class="language-javascript">
|
|
82
|
-
const CoCreateStripe = {
|
|
83
|
-
id: 'stripe', //. module id
|
|
84
|
-
actions: [ //. module actions
|
|
85
|
-
'CreateCustomer',
|
|
86
|
-
'CreateCard',
|
|
87
|
-
],
|
|
88
|
-
pre_CreateCustomer: function(data) {
|
|
89
|
-
console.log(data);
|
|
90
|
-
},
|
|
91
|
-
action_CreateCard: function(element, data) {
|
|
92
|
-
|
|
93
|
-
}
|
|
94
|
-
}
|
|
95
|
-
CoCreateApi.register(CoCreateStripe.id, CoCreateStripe);
|
|
96
|
-
</code></pre>
|
|
97
|
-
</p>
|
|
98
|
-
|
|
99
|
-
<h3 class="margin-top:20px padding:5px_0px">2. Cycle Chain</h3>
|
|
100
|
-
<h4>(1). When click action button, Run action</h4>
|
|
101
|
-
<h4>(2). Run action function.If action function defined in module, the action function (action_{action_name}) call.</h4>
|
|
102
|
-
<div class="padding-left:1rem">
|
|
103
|
-
<p>(2)-1. If action function defined in module, the action function (action_{action_name}) call.</p>
|
|
104
|
-
<p>(2)-2. If action funciton undefined in module, the common action function call.</p>
|
|
105
|
-
<div class="padding-left:1rem">
|
|
106
|
-
<p> - Get the dat from form</p>
|
|
107
|
-
<p> - Send the data and action by endpoint into server</p>
|
|
108
|
-
</div>
|
|
109
|
-
</div>
|
|
110
|
-
<h4>(3). Server Processing.</h4>
|
|
111
|
-
<h4>(4). Received the response from server.</h4>
|
|
112
|
-
<h4>(5). If pre-processing function defined in module, the pre-processing function (pre_{action_name}) call.</h4>
|
|
113
|
-
<h4>(6). Call the render function by action .</h4>
|
|
114
|
-
<h4>(7). Fire the event for end (event name is {action_name})</h4>
|
|
115
|
-
<h4>(8). Run the next action by cocreate-action</h4>
|
|
116
|
-
|
|
117
|
-
<h3 class="margin-top:20px padding:5px_0px">3. Description</h3>
|
|
118
|
-
<h4>Action function</h4>
|
|
119
|
-
<pre><code class="language-javascript">
|
|
120
|
-
---------------------Module-----------------
|
|
121
|
-
// element: Node to define action
|
|
122
|
-
// data: data to receive from previous action
|
|
123
|
-
function action_{action_name}(element, data)
|
|
124
|
-
--------------------HTML------------------------
|
|
125
|
-
<button actions="{action_name}, {action_name1}, ...">Run</button>
|
|
126
|
-
|
|
127
|
-
Example:
|
|
128
|
-
action_CreateCard: function(element, data) {}
|
|
129
|
-
<button actions="CreateCustomer, CreateCard">Run</button>
|
|
130
|
-
</code></pre>
|
|
131
|
-
<h4>Pre-processing function</h4>
|
|
132
|
-
<pre><code class="language-javascript">
|
|
133
|
-
// data: response data from server
|
|
134
|
-
function pre_{action_name}(data)
|
|
135
|
-
|
|
136
|
-
Example:
|
|
137
|
-
pre_CreateCard: function(data) {
|
|
138
|
-
localstorage['card'] = data['response'];
|
|
139
|
-
} </code></pre>
|
|
140
|
-
|
|
141
|
-
<h4 class="margin-top:20px padding:5px_0px">Server response</h4>
|
|
142
|
-
<pre><code class="language-javascript">{
|
|
143
|
-
type: "{action_name}",
|
|
144
|
-
response: {...}
|
|
145
|
-
}</code></pre>
|
|
146
|
-
|
|
147
|
-
<h2 class="border-bottom:1px_solid_lightgrey margin-top:20px padding:5px_0px">How Does It Works</h2>
|
|
148
|
-
<p>CoCreate-api module works based on cocreate.api. </p>
|
|
149
|
-
|
|
150
|
-
<p>xxxxxx <code class="language-js">action_{action_name}</code>. <code class="language-js">pre_{action_name}</code></p>
|
|
151
|
-
|
|
152
|
-
<h2 class="border-bottom:1px_solid_lightgrey margin-top:20px padding:5px_0px">Effects and Styles</h2>
|
|
153
|
-
|
|
154
|
-
<h2 class="border-bottom:1px_solid_lightgrey margin-top:20px padding:5px_0px">Events</h2>
|
|
155
|
-
<h4><span></span><span class="cocreate-badge success"></span></h4>
|
|
156
|
-
|
|
157
|
-
</div>
|
|
158
|
-
|
|
159
|
-
<div class="flex-grow:1 width:300px padding:0px_10px margin-top:60px border-bottom:1px_solid_lightgrey">
|
|
160
|
-
|
|
161
|
-
<!-- SandBox -->
|
|
162
|
-
<div id="api-demo" class="border-bottom:1px_solid_lightgrey" scroll scroll-intersect="color:dodgerblue" scroll-target="#api-demo-section">
|
|
163
|
-
<span class="display:flex align-items:center width:fit-content" hover="display:block!important" hover-target=
|
|
164
|
-
<h2 class="padding:5px_0px">Demo</h2>
|
|
165
|
-
<a class="margin-left:10px display:none" href="#api-demo"><i class="height:20px fill:#505050" src="/assets/svg/link.svg"></i></a>
|
|
166
|
-
</span>
|
|
167
|
-
</div>
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
<div class="position:sticky top:0 padding:15px_0px height:100vh">
|
|
171
|
-
<!-- SandBox -->
|
|
172
|
-
<div class="display:flex flex-direction:column position:relative overflow:hidden card border-radius:2px width:auto height:600px margin-top:20px" id="playground">
|
|
173
|
-
|
|
174
|
-
<div id="demo-code" resizable class="position:relative height:50%">
|
|
175
|
-
<textarea type="code" lang="html" collection="demos" document_id="" name="demo" save="false" id="demo" class="height:100% width:100% outline:none border:none resize:none padding:5px"></textarea>
|
|
176
|
-
<div resize="bottom" class="background:lightgrey"></div>
|
|
177
|
-
</div>
|
|
178
|
-
|
|
179
|
-
<div id="demo-preview" class="position:relative overflow:auto background-color:white">
|
|
180
|
-
<div class="demopreview
|
|
181
|
-
</div>
|
|
182
|
-
|
|
183
|
-
<div class="font-size:20px position:absolute top:10px right:10px opacity:0.6">
|
|
184
|
-
<a class="margin-right:10px" id="eye" show="#eye-slash" hide="#eye, #demo-preview" toggle="code-height" toggle-target="#demo-code"><i class="height:18px fill:#505050" src="/assets/svg/eye.svg"></i></a>
|
|
185
|
-
<a class="margin-right:10px" hidden id="eye-slash" show="#eye, #demo-preview" hide="#eye-slash" toggle="code-height" toggle-target="#demo-code"><i class="height:20px fill:#505050" src="/assets/svg/eye-slash.svg"></i></a>
|
|
186
|
-
<a class="margin-right:10px" id="code" show="#code-slash" hide="#code, #demo-code"><i class="height:20px fill:#505050" src="/assets/svg/code.svg"></i></a>
|
|
187
|
-
<a class="margin-right:10px" hidden id="code-slash" show="#code, #demo-code" hide="#code-slash"><i class="display:flex height:18px fill:#505050" src="/assets/svg/code.svg"></i></a>
|
|
188
|
-
<a class="margin-right:5px" fullscreen fullscreen-target="#playground"></a>
|
|
189
|
-
</div>
|
|
190
|
-
|
|
191
|
-
</div>
|
|
192
|
-
<!-- End SandBox -->
|
|
193
|
-
</div>
|
|
194
|
-
</div>
|
|
195
|
-
</div>
|
|
196
|
-
<button href="https://github.com/CoCreate-app/CoCreate-api/tree/master/docs/index.html?message=docs%3A%20describe%20your%20change..." target="_blank" class="position:fixed bottom:15px right:15px padding:15px background:dodgerblue color:#fff font-size:1.5rem grow-hover border-radius:50% border-width:0 box-shadow:0px_2px_10px_0px_rgba(0,_0,_0,_0.4)">
|
|
197
|
-
<i class="height:20px fill:#505050" src="/assets/svg/pencil-alt.svg"></i>
|
|
198
|
-
</button>
|
|
199
|
-
</main>
|
|
200
|
-
|
|
201
|
-
<script src="./apikey.js"></script>
|
|
202
|
-
<script src="https://cdn.cocreate.app/latest/CoCreate.min.js"></script>
|
|
203
|
-
|
|
204
|
-
</body>
|
|
205
|
-
|
|
206
|
-
</html>
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="utf-8">
|
|
6
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
7
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
8
|
+
<title>CoCreate-api module Documentation | CoCreateJS </title>
|
|
9
|
+
<link rel="icon" type="image/png" sizes="32x32" href="https://cocreate.app/images/favicon.ico">
|
|
10
|
+
<meta name="description" content="An api helper component in vanilla javascript to setup thirdparty api intergrations. Apis can be accessible using HTML5 attributes and/or JavaScript API" />
|
|
11
|
+
<meta name="keywords" content="drag and drop, colaboration, dnd utility, drag and drop utility" />
|
|
12
|
+
<meta name="robots" content="index,follow" />
|
|
13
|
+
<meta property="og:image" content="https://cdn.cocreate.app/docs/api.png">
|
|
14
|
+
|
|
15
|
+
<!-- CoCreate CSS -->
|
|
16
|
+
<link rel="stylesheet" href="https://cdn.cocreate.app/latest/CoCreate.min.css" type="text/css" />
|
|
17
|
+
<link rel="stylesheet" href="/docs/index.css" collection="files" document_id="60888216117c640e7596303f" name="src" type="text/css" save="true" />
|
|
18
|
+
<link rel="manifest" href="/manifest.webmanifest">
|
|
19
|
+
</head>
|
|
20
|
+
|
|
21
|
+
<body>
|
|
22
|
+
<nav class="nav display:flex align-items:center left:0px background:whitesmoke padding-top:10px padding-bottom:10px" content_id="content" scroll="sticky-nav,hide-nav" scroll-up="10" scroll-down="10" collection="files" document_id="60395ef42b3ac232657040fd" name="src">
|
|
23
|
+
</nav>
|
|
24
|
+
<sidenav id="menuL" class="position:fixed top:0px left:0px overflow:hidden background:whitesmoke height:100vh width:0px width:300px@xl" resizable resize-target="[content_id='content']" resize-property="margin-left" resize-value="width">
|
|
25
|
+
<menu collection="files" document_id="603717b07de7fb350ae9fec8" name="src"></menu>
|
|
26
|
+
<div resize="right"></div>
|
|
27
|
+
</sidenav>
|
|
28
|
+
<main class="padding-top:15px padding:15px@lg@xl" content_id="content" id="CoCreate-api-module">
|
|
29
|
+
<div class="display:flex flex-wrap:wrap justify-content:space-between position:relative margin:10px">
|
|
30
|
+
<div class="display:flex align-items:center">
|
|
31
|
+
<h2>CoCreate-api modules</h2>
|
|
32
|
+
</div>
|
|
33
|
+
<a href="https://github.com/CoCreate-app/CoCreate-dnd" target="_blank" class=""><i class="height:20px fill:#505050" src="/assets/svg/github.svg"></i></a>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<h1 class="max-width:500px margin:20px_10px line-height:1.5 font-size:16px font-weight:100">CoCreate-api is a simple api helper component in vanilla javascript used by JavaScript developers to create thirdparty api intergrations. Thirdparty apis can be accessible using HTML5 attributes and/or JavaScript API. CoCreate-api includes the
|
|
37
|
+
client component and server side for api processing.</h1>
|
|
38
|
+
<div id="api-section" class="display:flex flex-wrap:wrap">
|
|
39
|
+
<div class="flex-grow:1 width:400px width:300px@xs padding:0px_10px margin-top:60px">
|
|
40
|
+
|
|
41
|
+
<div id="api-install" class="border-bottom:1px_solid_lightgrey" scroll scroll-intersect="color:dodgerblue" scroll-target="#api-install-section">
|
|
42
|
+
<span class="display:flex align-items:center width:fit-content" hover="display:block!important" hover-target="[href='#api-install']">
|
|
43
|
+
<h2 class="padding:5px_0px">Install</h2>
|
|
44
|
+
<a class="margin-left:10px display:none" href="#api-install"><i class="height:20px fill:#505050" src="/assets/svg/link.svg"></i></a>
|
|
45
|
+
</span>
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<p class="padding:10px_0px line-height:1.5">
|
|
49
|
+
<pre><code class="language-bash">npm i @cocreate/api</code></pre>
|
|
50
|
+
</p>
|
|
51
|
+
<p class="padding:10px_0px line-height:1.5">Or you can use cdn link:</p>
|
|
52
|
+
<pre><code class="language-html"><script>https://cdn.cocreate.app/api/latest/CoCreate-api.min.js</script></code></pre>
|
|
53
|
+
|
|
54
|
+
<div>
|
|
55
|
+
<h2 id="api-dependencies" hover="display:block" hover-target="" class="border-bottom:1px_solid_lightgrey margin-top:80px padding:5px_0px">Dependencies components</h2>
|
|
56
|
+
<a class="display:none" href="#api-dependencies"><i class="height:20px fill:#505050" src="/assets/svg/link.svg"></i></a>
|
|
57
|
+
</div>
|
|
58
|
+
<p class="padding:10px_0px line-height:1.5">
|
|
59
|
+
<strong>CoCreate.js</strong>,
|
|
60
|
+
<strong>CoCreate-api.js</strong>,
|
|
61
|
+
</p>
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
<div>
|
|
65
|
+
<h2 id="api-development" hover="display:block" hover-target="" class="border-bottom:1px_solid_lightgrey margin-top:80px padding:5px_0px">Development Guide</h2>
|
|
66
|
+
<a class="display:none" href="#api-development"><i class="height:20px fill:#505050" src="/assets/svg/link.svg"></i></a>
|
|
67
|
+
</div>
|
|
68
|
+
|
|
69
|
+
<h3 class="margin-top:20px padding:5px_0px">1. Rules</h3>
|
|
70
|
+
<h4>(1). Module should be CoCreate-{module_id}.js</h4>
|
|
71
|
+
<pre><code class="language-javascript">Ex: CoCreate-stripe.js</code></pre>
|
|
72
|
+
<h4>(2). Module should include the actions that has unique name</h4>
|
|
73
|
+
<h4>(3). Module id and the endpoint is same.</h4>
|
|
74
|
+
<h4>(4). Action function name should be "action_{action_name}"</h4>
|
|
75
|
+
<h4>(5). Pre-processing function name should be "pre_{action_name}"</h4>
|
|
76
|
+
<h4>(6). Register module</h4>
|
|
77
|
+
<pre><code class="language-javascript">Ex: CoCreateApi.register(CoCreateStripe.id, CoCreateStripe);</code></pre>
|
|
78
|
+
|
|
79
|
+
<p class="padding:10px_0px line-height:1.5">
|
|
80
|
+
Stripe modules case's example
|
|
81
|
+
<pre><code class="language-javascript">
|
|
82
|
+
const CoCreateStripe = {
|
|
83
|
+
id: 'stripe', //. module id
|
|
84
|
+
actions: [ //. module actions
|
|
85
|
+
'CreateCustomer',
|
|
86
|
+
'CreateCard',
|
|
87
|
+
],
|
|
88
|
+
pre_CreateCustomer: function(data) {
|
|
89
|
+
console.log(data);
|
|
90
|
+
},
|
|
91
|
+
action_CreateCard: function(element, data) {
|
|
92
|
+
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
CoCreateApi.register(CoCreateStripe.id, CoCreateStripe);
|
|
96
|
+
</code></pre>
|
|
97
|
+
</p>
|
|
98
|
+
|
|
99
|
+
<h3 class="margin-top:20px padding:5px_0px">2. Cycle Chain</h3>
|
|
100
|
+
<h4>(1). When click action button, Run action</h4>
|
|
101
|
+
<h4>(2). Run action function.If action function defined in module, the action function (action_{action_name}) call.</h4>
|
|
102
|
+
<div class="padding-left:1rem">
|
|
103
|
+
<p>(2)-1. If action function defined in module, the action function (action_{action_name}) call.</p>
|
|
104
|
+
<p>(2)-2. If action funciton undefined in module, the common action function call.</p>
|
|
105
|
+
<div class="padding-left:1rem">
|
|
106
|
+
<p> - Get the dat from form</p>
|
|
107
|
+
<p> - Send the data and action by endpoint into server</p>
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<h4>(3). Server Processing.</h4>
|
|
111
|
+
<h4>(4). Received the response from server.</h4>
|
|
112
|
+
<h4>(5). If pre-processing function defined in module, the pre-processing function (pre_{action_name}) call.</h4>
|
|
113
|
+
<h4>(6). Call the render function by action .</h4>
|
|
114
|
+
<h4>(7). Fire the event for end (event name is {action_name})</h4>
|
|
115
|
+
<h4>(8). Run the next action by cocreate-action</h4>
|
|
116
|
+
|
|
117
|
+
<h3 class="margin-top:20px padding:5px_0px">3. Description</h3>
|
|
118
|
+
<h4>Action function</h4>
|
|
119
|
+
<pre><code class="language-javascript">
|
|
120
|
+
---------------------Module-----------------
|
|
121
|
+
// element: Node to define action
|
|
122
|
+
// data: data to receive from previous action
|
|
123
|
+
function action_{action_name}(element, data)
|
|
124
|
+
--------------------HTML------------------------
|
|
125
|
+
<button actions="{action_name}, {action_name1}, ...">Run</button>
|
|
126
|
+
|
|
127
|
+
Example:
|
|
128
|
+
action_CreateCard: function(element, data) {}
|
|
129
|
+
<button actions="CreateCustomer, CreateCard">Run</button>
|
|
130
|
+
</code></pre>
|
|
131
|
+
<h4>Pre-processing function</h4>
|
|
132
|
+
<pre><code class="language-javascript">
|
|
133
|
+
// data: response data from server
|
|
134
|
+
function pre_{action_name}(data)
|
|
135
|
+
|
|
136
|
+
Example:
|
|
137
|
+
pre_CreateCard: function(data) {
|
|
138
|
+
localstorage['card'] = data['response'];
|
|
139
|
+
} </code></pre>
|
|
140
|
+
|
|
141
|
+
<h4 class="margin-top:20px padding:5px_0px">Server response</h4>
|
|
142
|
+
<pre><code class="language-javascript">{
|
|
143
|
+
type: "{action_name}",
|
|
144
|
+
response: {...}
|
|
145
|
+
}</code></pre>
|
|
146
|
+
|
|
147
|
+
<h2 class="border-bottom:1px_solid_lightgrey margin-top:20px padding:5px_0px">How Does It Works</h2>
|
|
148
|
+
<p>CoCreate-api module works based on cocreate.api. </p>
|
|
149
|
+
|
|
150
|
+
<p>xxxxxx <code class="language-js">action_{action_name}</code>. <code class="language-js">pre_{action_name}</code></p>
|
|
151
|
+
|
|
152
|
+
<h2 class="border-bottom:1px_solid_lightgrey margin-top:20px padding:5px_0px">Effects and Styles</h2>
|
|
153
|
+
|
|
154
|
+
<h2 class="border-bottom:1px_solid_lightgrey margin-top:20px padding:5px_0px">Events</h2>
|
|
155
|
+
<h4><span></span><span class="cocreate-badge success"></span></h4>
|
|
156
|
+
|
|
157
|
+
</div>
|
|
158
|
+
|
|
159
|
+
<div class="flex-grow:1 width:300px padding:0px_10px margin-top:60px border-bottom:1px_solid_lightgrey">
|
|
160
|
+
|
|
161
|
+
<!-- SandBox -->
|
|
162
|
+
<div id="api-demo" class="border-bottom:1px_solid_lightgrey" scroll scroll-intersect="color:dodgerblue" scroll-target="#api-demo-section">
|
|
163
|
+
<span class="display:flex align-items:center width:fit-content" hover="display:block!important" hover-target="[href='#api-demo']">
|
|
164
|
+
<h2 class="padding:5px_0px">Demo</h2>
|
|
165
|
+
<a class="margin-left:10px display:none" href="#api-demo"><i class="height:20px fill:#505050" src="/assets/svg/link.svg"></i></a>
|
|
166
|
+
</span>
|
|
167
|
+
</div>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<div class="position:sticky top:0 padding:15px_0px height:100vh">
|
|
171
|
+
<!-- SandBox -->
|
|
172
|
+
<div class="display:flex flex-direction:column position:relative overflow:hidden card border-radius:2px width:auto height:600px margin-top:20px" id="playground">
|
|
173
|
+
|
|
174
|
+
<div id="demo-code" resizable class="position:relative height:50%">
|
|
175
|
+
<textarea type="code" lang="html" collection="demos" document_id="" name="demo" save="false" id="demo" class="height:100% width:100% outline:none border:none resize:none padding:5px"></textarea>
|
|
176
|
+
<div resize="bottom" class="background:lightgrey"></div>
|
|
177
|
+
</div>
|
|
178
|
+
|
|
179
|
+
<div id="demo-preview" class="position:relative overflow:auto background-color:white">
|
|
180
|
+
<div class="demopreview padding:20px"></div>
|
|
181
|
+
</div>
|
|
182
|
+
|
|
183
|
+
<div class="font-size:20px position:absolute top:10px right:10px opacity:0.6">
|
|
184
|
+
<a class="margin-right:10px" id="eye" show="#eye-slash" hide="#eye, #demo-preview" toggle="code-height" toggle-target="#demo-code"><i class="height:18px fill:#505050" src="/assets/svg/eye.svg"></i></a>
|
|
185
|
+
<a class="margin-right:10px" hidden id="eye-slash" show="#eye, #demo-preview" hide="#eye-slash" toggle="code-height" toggle-target="#demo-code"><i class="height:20px fill:#505050" src="/assets/svg/eye-slash.svg"></i></a>
|
|
186
|
+
<a class="margin-right:10px" id="code" show="#code-slash" hide="#code, #demo-code"><i class="height:20px fill:#505050" src="/assets/svg/code.svg"></i></a>
|
|
187
|
+
<a class="margin-right:10px" hidden id="code-slash" show="#code, #demo-code" hide="#code-slash"><i class="display:flex height:18px fill:#505050" src="/assets/svg/code.svg"></i></a>
|
|
188
|
+
<a class="margin-right:5px" fullscreen fullscreen-target="#playground"></a>
|
|
189
|
+
</div>
|
|
190
|
+
|
|
191
|
+
</div>
|
|
192
|
+
<!-- End SandBox -->
|
|
193
|
+
</div>
|
|
194
|
+
</div>
|
|
195
|
+
</div>
|
|
196
|
+
<button href="https://github.com/CoCreate-app/CoCreate-api/tree/master/docs/index.html?message=docs%3A%20describe%20your%20change..." target="_blank" class="position:fixed bottom:15px right:15px padding:15px background:dodgerblue color:#fff font-size:1.5rem grow-hover border-radius:50% border-width:0 box-shadow:0px_2px_10px_0px_rgba(0,_0,_0,_0.4)">
|
|
197
|
+
<i class="height:20px fill:#505050" src="/assets/svg/pencil-alt.svg"></i>
|
|
198
|
+
</button>
|
|
199
|
+
</main>
|
|
200
|
+
|
|
201
|
+
<script src="./apikey.js"></script>
|
|
202
|
+
<script src="https://cdn.cocreate.app/latest/CoCreate.min.js"></script>
|
|
203
|
+
|
|
204
|
+
</body>
|
|
205
|
+
|
|
206
|
+
</html>
|