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

add version and explain howto custom menu-item #24

Merged
merged 1 commit into from
Jun 20, 2019
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
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ export class AppComponent {
}
```

Learn more about [AnsynApi](https://github.com/AnSyn/ansyn/wiki/Ansyn-Package).

on `app.component.css`:

The element `ansyn-app` has to receive height. It can be explicit height, or implicit like "display:flex" + "flex:1"
Expand All @@ -100,3 +102,27 @@ ansyn-app {
}
```

on `main.ts`:

You can provide an object that override the default configuration of your Ansyn app.(let's say we called it overrideConfig) ,
then you need to pass it to the `fetchConfigProviders` function from `@ansyn/ansyn` with the path of the original configuration('assets/config/app.config.json') which return you a promise with provider then pass it to `platformBrowserDynamic` function.
```typescript
fetchConfigProviders('assets/config/app.config.json', overrideConfig)
.then(providers => platformBrowserDynamic(providers).bootstrapModule(AppModule).catch(err => console.log(err)));
```
Learn more about `Ansyn` [configuration](https://github.com/AnSyn/ansyn/wiki/Ansyn-configuration).

### Add custome menu item

You could add your own custom menu item, in a few simple step.

1. Create a new component for your menu item.
2. In `main.ts` before you call `fetchConfigProviders` tell `ansynConfig.ansynMenuItems`about your custom menu item by pushing him an object look like:
```typescript
{
name: 'THE_MENU_ITEM_NAME',
component: YOUR_COMPONENT,
iconClass: 'YOUR_MENU_ITEM_ICON_CLASS'
}
```
next add your menu item name to `menuConfig.menuItems`
2 changes: 1 addition & 1 deletion src/app/app.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ <h1> Angular 2 implementation </h1>

</div>

<ansyn-app></ansyn-app>
<ansyn-app [version]="version"></ansyn-app>
3 changes: 3 additions & 0 deletions src/app/app.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import { Observable } from 'rxjs';
import { take, tap } from 'rxjs/operators';
import { layoutOptions } from '@ansyn/map-facade';
import { LayoutKey } from '@ansyn/map-facade';
import * as packageJson from 'root/package.json';


const moment = momentNs;

Expand All @@ -29,6 +31,7 @@ export class AppComponent {
this.overlay('333', 'https://image.shutterstock.com/z/stock-vector-cool-milkshake-190524542.jpg',
1600, 1500, this.calcDate(3))
];
version: string = (<any>packageJson).dependencies['@ansyn/ansyn'].replace(/[/^/~]/g , '');

calcDate(days: number) {
return moment().subtract(days, 'day').toDate();
Expand Down
13 changes: 13 additions & 0 deletions src/typings.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
declare module '*.json' {
const value: any;
export default value;
}

declare module '*package.json' {
const value: {
dependencies: {
[deps: string]: string
};
};
export default value;
}
5 changes: 4 additions & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
"lib": [
"es2017",
"dom"
]
],
"paths": {
"root/package.json": ["./package.json"]
}
}
}