-
Notifications
You must be signed in to change notification settings - Fork 75
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
Add API Usage docs to @glimmer/ssr #351
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I was able to embed components with the following hack: import { setComponentTemplate } from '@glimmer/core';
import component from '@glimmer/component';
import { renderToString } from '@glimmer/ssr';
import { templateFactory } from '@glimmer/opcode-compiler';
import { precompileJSON } from '@glimmer/compiler';
let GlimmerComponent = component.default;
let templateId = 0;
// NOTE: this function is needed instead of @glimmer/core precompile?
function createTemplate(
templateSource,
options,
scopeValues = {}
) {
options.locals = options.locals ?? Object.keys(scopeValues ?? {});
let [block, usedLocals] = precompileJSON(templateSource, options);
let reifiedScopeValues = usedLocals.map((key) => scopeValues[key]);
let templateBlock = {
id: String(templateId++),
block: JSON.stringify(block),
moduleName: options.meta?.moduleName ?? '(unknown template module)',
scope: reifiedScopeValues.length > 0 ? () => reifiedScopeValues : null,
isStrictMode: options.strictMode ?? false,
};
return templateFactory(templateBlock);
}
class AnotherComponent extends GlimmerComponent {}
setComponentTemplate(
createTemplate(`<h5>This is another component</h5>`, { strictMode: true }),
AnotherComponent
);
class PageComponent extends GlimmerComponent {}
setComponentTemplate(
createTemplate(`
{{#let "hello" "world" as |hello world|}}<p>{{hello}} {{world}}</p>{{/let}}
<AnotherComponent />
`, {
strictMode: true,
}, { AnotherComponent: AnotherComponent }),
PageComponent
);
// prints the rendered html of PageComponent including AnotherComponent
console.log(await renderToString(PageComponent, {
owner: {
services: {
},
},
})); |
izelnakri
force-pushed
the
add-docs-to-ssr
branch
from
May 19, 2021 23:10
fb755c4
to
b16346a
Compare
ok everything works with import { setComponentTemplate, getOwner, helperCapabilities, setHelperManager } from '@glimmer/core';
import component from '@glimmer/component';
import { renderToString } from '@glimmer/ssr';
import { templateFactory } from '@glimmer/opcode-compiler';
import { artifacts } from '@glimmer/program';
import { precompile, precompileJSON } from '@glimmer/compiler';
// FRAMEWORK SETUP:
// =================
let GlimmerComponent = component.default;
let templateId = 0;
function createTemplate(
templateSource,
options,
scopeValues = {}
) {
options.locals = options.locals ?? Object.keys(scopeValues ?? {});
let [block, usedLocals] = precompileJSON(templateSource, options);
let reifiedScopeValues = usedLocals.map((key) => scopeValues[key]);
let templateBlock = {
id: String(templateId++),
block: JSON.stringify(block),
moduleName: options.meta?.moduleName ?? '(unknown template module)',
scope: reifiedScopeValues.length > 0 ? () => reifiedScopeValues : null,
isStrictMode: options.strictMode ?? false,
};
return templateFactory(templateBlock);
}
class HelperWithServicesManager {
capabilities = helperCapabilities('3.23', {
hasValue: true,
});
constructor(owner) {
this.owner = owner;
}
createHelper(fn, args) {
return { fn, args, services: this.owner.services };
}
getValue(instance) {
const { args, services } = instance;
return instance.fn(args.positional, args.named, services);
}
}
const HelperWithServicesManagerFactory = (owner) => new HelperWithServicesManager(owner);
function helper(fn) {
setHelperManager(HelperWithServicesManagerFactory, fn);
return fn;
}
// ==============================
// APPLICATION CODE:
// ==============================
class AnotherComponent extends GlimmerComponent {
get localeService() {
return getOwner(this).services.locale;
}
get currentLocale() {
return getOwner(this).services.locale.currentLocale;
}
}
setComponentTemplate(
createTemplate(`
<h5>This is another component</h5>
<p>Current locale is {{this.currentLocale}}, description: {{this.localeService.description}}</p>
`, { strictMode: true }),
AnotherComponent
);
const myHelper = helper(function ([name], { greeting }) {
return `Helper: ${greeting} ${name}`;
});
const isUSA = helper(function (_args, _hash, services) {
const localeService = services.locale;
return localeService.currentLocale === 'en_US';
});
class PageComponent extends GlimmerComponent {}
setComponentTemplate(
createTemplate(`
{{#let "hello" "world" as |hello world|}}<p>{{hello}} {{world}}</p>{{/let}}
{{myHelper "foo" greeting="Hello"}}
<p>Current locale: {{this.currentLocale}}</p>
{{#if (isUSA)}}
<p>Component is in a US locale</p>
{{else}}
<p>Component is not in a US locale</p>
{{/if}}
<AnotherComponent />
`, { strictMode: true }, { AnotherComponent, myHelper, isUSA }
),
PageComponent
);
class LocaleService {
currentLocale = "es";
constructor(currentLocale) {
this.currentLocale = currentLocale;
}
get locales() {
if (this.currentLocale === "en") {
return {
"button.save": "Save model",
"button.delete": "Delete model",
"profile.about.description": "This is description",
};
}
return {
"button.save": "Guardar modelo",
"button.delete": "Eliminar modelo",
"profile.about.description": "Esta es un description",
};
}
get description() {
return this.locales['profile.about.description'];
}
t(key) {
return this.locales[this.currentLocale][key];
}
}
// ============================
// SERVER-SIDE RENDERING: (outputs everything correctly)
// ============================
console.log(await renderToString(PageComponent, {
owner: {
services: {
locale: new LocaleService('en_US')
}
},
}));
// ============================ |
Awesome, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This documentation might be helpful for others trying to figure out how this works, it will show up in the npm after a new release.
I still haven't figured out how to embed components inside component scopes, still trying to figure out how.
The code below doesn't work for template imports/component composition(fixed in other comments below):