Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

auto/manual init w/ single bundle, BYO root element 🎉 #1173

Merged
merged 3 commits into from
Mar 28, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions src/bootstrap.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ import 'EditorWidgets';
import 'MarkdownPlugins';
import './index.css';

function bootstrap(opts = {}) {
const ROOT_ID = 'nc-root';

function bootstrap(opts = {}) {
const { config } = opts;

/**
Expand All @@ -23,11 +24,25 @@ function bootstrap(opts = {}) {
console.log(`Netlify CMS version ${NETLIFY_CMS_VERSION}`);

/**
* Create mount element dynamically.
* Get DOM element where app will mount.
*/
const el = document.createElement('div');
el.id = 'nc-root';
document.body.appendChild(el);
function getRoot() {
/**
* Return existing root if found.
*/
const existingRoot = document.getElementById(ROOT_ID);
if (existingRoot) {
return existingRoot;
}

/**
* If no existing root, create and return a new root.
*/
const newRoot = document.createElement('div');
newRoot.id = ROOT_ID;
document.body.appendChild(newRoot);
return newRoot;
}

/**
* Configure Redux store.
Expand Down Expand Up @@ -64,7 +79,7 @@ function bootstrap(opts = {}) {
/**
* Render application root.
*/
render(<Root />, el);
render(<Root />, getRoot());
}

export default bootstrap;
21 changes: 9 additions & 12 deletions src/index.js
Original file line number Diff line number Diff line change
@@ -1,28 +1,25 @@
/**
* This module provides a self-initializing CMS instance with API hooks added to
* the `window` object.
*/
import React from 'react';
import bootstrap from './bootstrap';
import registry from 'Lib/registry';
import createReactClass from 'create-react-class';

/**
* Load the app.
* Load Netlify CMS automatically if `window.CMS_MANUAL_INIT` is set.
*/
bootstrap();
if (!window.CMS_MANUAL_INIT) {
bootstrap();
} else {
console.log('`window.CMS_MANUAL_INIT` flag set, skipping automatic initialization.');
}

/**
* Add extension hooks to global scope.
*/
const CMS = { ...registry };
if (typeof window !== 'undefined') {
window.CMS = CMS;
window.CMS = registry;
window.initCMS = bootstrap;
window.createClass = window.createClass || createReactClass;
window.h = window.h || React.createElement;
}

/**
* Export the registry for projects that import the CMS.
*/
export default CMS;
export { registry as default, bootstrap as init };
7 changes: 0 additions & 7 deletions src/init.js

This file was deleted.

1 change: 0 additions & 1 deletion webpack.dev.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ module.exports = merge.smart(require('./webpack.base.js'), {
`webpack-dev-server/client?http://${ HOST }:${ PORT }/`,
'./index',
],
init: './init',
},
output: {
path: path.join(__dirname, 'dist'),
Expand Down
1 change: 0 additions & 1 deletion webpack.prod.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ const UglifyJsPlugin = require('uglifyjs-webpack-plugin');
module.exports = merge.smart(require('./webpack.base.js'), {
entry: {
cms: './index',
init: './init',
},
output: {
path: path.join(__dirname, 'dist'),
Expand Down
22 changes: 19 additions & 3 deletions website/site/content/docs/beta-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,31 @@ We run new functionality in an open beta format from time to time. That means th

**Use these features at your own risk.**

## Custom Mount Element
Netlify CMS always creates it's own DOM element for mounting the application, which means it always
takes over the entire page, and is generally inflexible if you're trying to do something creative,
like injecting it into a shared context.

You can now provide your own element for Netlify CMS to mount in by setting the target element's ID
as `nc-root`. If Netlify CMS finds an element with this ID during initialization, it will mount
within that element instead of creating it's own.

## Manual Initialization
Netlify CMS can now be manually initialized, rather than automatically loading up the moment you import it. The whole point of this at the moment is to inject configuration into Netlify CMS before it loads, bypassing need for an actual config.yml. This is important, for example, when creating tight integrations with static site generators.

Injecting config is technically already possible by setting `window.CMS_CONFIG` before importing/requiring/running Netlify CMS, but most projects are modular and don't want to use globals, plus `window.CMS_CONFIG` is an internal, not technically supported, and provides no validation. Therefore, we'll focus on manual initialization via the npm package.
Injecting config is technically already possible by setting `window.CMS_CONFIG` before importing/requiring/running Netlify CMS, but most projects are modular and don't want to use globals, plus `window.CMS_CONFIG` is an internal, not technically supported, and provides no validation.

Assuming you have the netlify-cms package installed to your project, manual initialization works like so:

```js
import { init, registry } from 'netlify-cms/dist/init'
// This global flag enables manual initialization.
window.CMS_MANUAL_INIT = true

// Usage with import from npm package
import CMS, { init } from 'netlify-cms'

// Usage with script tag
const { CMS, initCMS: init } = window

/**
* Initialize without passing in config - equivalent to just importing
Expand All @@ -42,5 +58,5 @@ init({
})

// The registry works as expected, and can be used before or after init.
registry.registerPreviewTemplate(...);
CMS.registerPreviewTemplate(...);
```