summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFilipa Lacerda <filipa@gitlab.com>2019-04-16 09:35:49 +0000
committerFilipa Lacerda <filipa@gitlab.com>2019-04-16 16:51:46 +0100
commitf1717dc784b33947618845b49f7fd841c57ffb2e (patch)
treeca173c6297d4035c0ffac0613f89dc615cb96bc9 /doc
parenta67b1c17a1284daf6e7f12d3f9c4a80fae59dde9 (diff)
downloadgitlab-ce-f1717dc784b33947618845b49f7fd841c57ffb2e.tar.gz
Removes ifEE example for JS codefilipa-master-patch-09545
Diffstat (limited to 'doc')
-rw-r--r--doc/development/ee_features.md42
1 files changed, 11 insertions, 31 deletions
diff --git a/doc/development/ee_features.md b/doc/development/ee_features.md
index c5a1d915be6..9853b38b8e9 100644
--- a/doc/development/ee_features.md
+++ b/doc/development/ee_features.md
@@ -922,7 +922,7 @@ import mixin from 'ee_else_ce/path/mixin';
mixins: [mixin]
}
```
-
+
- Computed Properties/methods and getters only used in the child import still need a counterpart in CE
- For store modules, we will need a CE counterpart too.
@@ -933,47 +933,27 @@ import mixin from 'ee_else_ce/path/mixin';
- Since we are using the async loading to check which component to load, we'd still use the component's name, check [this example](#child-component-only-used-in-ee).
* **EE extra HTML**
- - For the templates that have extra HTML in EE we will use the `ifEE` mixin with the `v-if` directive.
- - You can either use the `template` tag as a wrapper or directly in the element, if there is only one element to be rendered in EE:
-
-```html
- <template v-if="ifEE">
- <p>Several</p>
- <p>non wrapper</p>
- <p>elements</p>
- <p>that are rendered</p>
- <p>in EE only</p>
- </template>
-```
-
-
-```html
- <ul v-if="ifEE">
- <li>One wrapped</li>
- <li>element</li>
- <li>that is rendered</li>
- <li>in EE only</li>
- </template>
-```
+ - For the templates that have extra HTML in EE we should move it into a new component and use the `ee_else_ce` dynamic import
### Non Vue Files
For regular JS files, the approach is similar.
1. We will keep using the [`ee_else_ce`](https://docs.gitlab.com/ee/development/ee_features.html#javascript-code-in-assetsjavascripts) helper, this means that EE only code should be inside the `ee/` folder.
1. An EE file should be created with the EE only code, and it should extend the CE counterpart.
-1. For code inside functions that can't be extended, we will use an `if` statement with the `ifEE` helper
+ 1. For code inside functions that can't be extended, the code should be moved into a new file and we should use `ee_else_ce` helper:
##### Example:
```javascript
-import { ifEE } from '~/lib/utils/common_utils'
-if (ifEE) {
- $('.js-import-git-toggle-button').on('click', () => {
- const $projectMirror = $('#project_mirror');
+ import eeCode from 'ee_else_ce/ee_code';
- $projectMirror.attr('disabled', !$projectMirror.attr('disabled'));
- });
-}
+ function test() {
+ const test = 'a';
+
+ eeCode();
+
+ return test;
+ }
```
## SCSS code in `assets/stylesheets`