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

Extend ExampleDescription with optional i18n configuration #1974

Merged
merged 1 commit into from
Jul 15, 2022
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
11 changes: 7 additions & 4 deletions packages/angular-material/example/app/app.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
*/
import { Component } from '@angular/core';
import { ExampleDescription, getExamples } from '@jsonforms/examples';
import { UISchemaElement, UISchemaTester } from '@jsonforms/core';
import { JsonFormsI18nState, UISchemaElement, UISchemaTester } from '@jsonforms/core';
import { angularMaterialRenderers } from '../../src/index';
import { DateAdapter } from '@angular/material/core';

Expand All @@ -41,6 +41,9 @@ const uiSchema = {
}
]
};
const defaultI18n: JsonFormsI18nState = {
locale: 'en-US'
};
const itemTester: UISchemaTester = (_schema, schemaPath, _path) => {
if (schemaPath === '#/properties/warehouseitems/items') {
return 10;
Expand Down Expand Up @@ -88,9 +91,7 @@ export class AppComponent {
readonly renderers = angularMaterialRenderers;
readonly examples = getExamples();
selectedExample: ExampleDescription;
i18n = {
locale: 'en-US'
}
i18n: JsonFormsI18nState;
private dateAdapter;
private readonly = false;
data: any;
Expand All @@ -101,11 +102,13 @@ export class AppComponent {
constructor(dateAdapter: DateAdapter<Date>) {
this.selectedExample = this.examples[19];
this.dateAdapter = dateAdapter;
this.i18n = this.selectedExample.i18n ?? defaultI18n;
dateAdapter.setLocale(this.i18n.locale);
}

onChange(ev: any) {
this.selectedExample = this.examples.find(e => e.name === ev.target.value);
this.i18n = this.selectedExample.i18n ?? defaultI18n;
}

changeLocale(locale: string) {
Expand Down
4 changes: 3 additions & 1 deletion packages/example/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,16 @@ const getProps = (example: ExampleDescription, cells?: any, renderers?: any) =>
const data = example.data;
const uischemas = example.uischemas;
const config = example.config;
const i18n = example.i18n;
return {
schema,
uischema,
data,
config,
uischemas,
cells,
renderers
renderers,
i18n
}
}

Expand Down
6 changes: 4 additions & 2 deletions packages/examples/src/example.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ import {
JsonFormsUISchemaRegistryEntry,
JsonFormsRendererRegistryEntry,
JsonSchema,
UISchemaElement
UISchemaElement,
JsonFormsI18nState
} from '@jsonforms/core';

export interface ExampleDescription {
Expand All @@ -38,7 +39,8 @@ export interface ExampleDescription {
uischema: UISchemaElement;
uischemas?: JsonFormsUISchemaRegistryEntry[];
config?: any;
actions?: {label: string, apply: (props: StateProps) => any}[];
actions?: { label: string, apply: (props: StateProps) => any }[];
i18n?: JsonFormsI18nState;
}

export interface StateProps {
Expand Down
18 changes: 15 additions & 3 deletions packages/examples/src/examples/categorization.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
import { Translator } from '@jsonforms/core';
import get from 'lodash/get';
import { registerExamples } from '../register';

export const schema = {
Expand Down Expand Up @@ -93,7 +95,7 @@ export const uischema = {
elements: [
{
type: 'Category',
label: 'Basic Information',
label: 'categoryLabelKey',
elements: [
{
type: 'HorizontalLayout',
Expand Down Expand Up @@ -133,7 +135,7 @@ export const uischema = {
},
{
type: 'Category',
label: 'Address',
i18n: 'address',
elements: [
{
type: 'HorizontalLayout',
Expand Down Expand Up @@ -284,14 +286,24 @@ const uischema_1713 = {
]
};

export const translations = {
categoryLabelKey: 'Basic',
address: {
label: "Address",
},
};
export const translate: Translator = (key: string, defaultMessage: string) => {
return get(translations, key) ?? defaultMessage
};

registerExamples([
{
name: 'categorization',
label: 'Categorization',
data,
schema,
uischema
uischema,
i18n: { locale: 'en', translate: translate }
},
{
name: '1713',
Expand Down
24 changes: 20 additions & 4 deletions packages/examples/src/examples/i18n.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
*/
import { registerExamples } from '../register';
import { personCoreSchema } from './person';
import { JsonFormsCore, updateErrors, AnyAction, Dispatch } from '@jsonforms/core';
import { JsonFormsCore, updateErrors, AnyAction, Dispatch, Translator } from '@jsonforms/core';
import get from 'lodash/get';
const localize = require('ajv-i18n');

export const onChange = (dispatch: Dispatch<AnyAction>) => (
Expand All @@ -42,7 +43,8 @@ export const uischema = {
type: 'VerticalLayout',
elements: [
{
type: 'HorizontalLayout',
type: 'Group',
i18n: 'basicInfoGroup',
elements: [
{
type: 'Control',
Expand All @@ -56,7 +58,7 @@ export const uischema = {
},
{
type: 'Label',
text: 'Additional Information'
text: 'additionalInformationLabel',
},
{
type: 'HorizontalLayout',
Expand All @@ -83,12 +85,26 @@ export const data = {
postalCode: '12345'
};

export const translations = {
basicInfoGroup: {
label: 'Basic Information'
},
additionalInformationLabel: 'Additional Information'
};
export const translate: Translator = (key: string, defaultMessage: string) => {
return get(translations, key) ?? defaultMessage;
};

registerExamples([
{
name: 'i18n',
label: 'Person (i18n)',
data,
schema: personCoreSchema,
uischema
uischema,
i18n: {
translate: translate,
locale: 'en'
}
}
]);