Skip to content

docs(quickstart): update quickstart for v49 #1480

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.

Sign up for GitHub

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

Open
spike-rabbit wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(quickstart): update quickstart for v49 #1480

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 43 additions & 4 deletions docs/get-started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ Answer the following questions as desired. Note: We are not yet

- `@siemens/element-ng` provides the components
- `@siemens/element-theme` provides global styles
- `@siemens/element-icons` provides the icons
- `@siemens/element-translate-ng` provides a facade for different translation
libraries (or none), including `ngx-translate` and `@angular/localize`
- `@angular/cdk` for support from the Angular component development kit
Expand Down Expand Up @@ -162,9 +163,9 @@ update the imports in the `app.ts` accordingly.
</div>
</div>
<div class="dropdown-divider"></div>
<button si-header-dropdown-item icon="element-user" type="button">Profile</button>
<button si-header-dropdown-item type="button" [icon]="icons.elementUser">Profile</button>
<div class="dropdown-divider"></div>
<button si-header-dropdown-item icon="element-logout" type="button">Logout</button>
<button si-header-dropdown-item type="button" [icon]="icons.elementLogout">Logout</button>
</si-header-dropdown>
</ng-template>
```
Expand All @@ -184,6 +185,8 @@ import {
SiHeaderDropdownItemComponent,
SiHeaderDropdownTriggerDirective
} from '@siemens/element-ng/header-dropdown';
import { addIcons } from '@siemens/element-ng/icon';
import { elementLogout, elementUser } from '@siemens/element-icons';

@Component({
selector: 'app-root',
Expand All @@ -201,10 +204,46 @@ import {
templateUrl: './app.html',
styleUrl: './app.scss'
})
export class App {}
export class App {
protected readonly icons = addIcons({
elementUser,
elementLogout
});
}
```

## Step 5 - Start the application
## Step 5 - Add Siemens Theme (optional / only for Siemens Apps)

Install the Siemens brand package:

```sh
npm install @simpl/brand
```

Update the `styles.scss` to include the Siemens brand assets:

```scss
@use '@simpl/brand/assets/fonts/styles/siemens-sans';

@use '@simpl/brand/dist/element-theme-siemens-brand-light' as brand-light;
@use '@simpl/brand/dist/element-theme-siemens-brand-dark' as brand-dark;

// This replaces the previous @use '@siemens/element-theme/src/theme' statement and needs to be added after the brand themes.
@use '@siemens/element-theme/src/theme' with (
$element-theme-default: 'siemens-brand',
$element-themes: (
'siemens-brand',
'element'
)
);

// Create the an Element theme based on the Siemens brand tokens.
@use '@siemens/element-theme/src/styles/themes';
@include themes.make-theme(brand-light.$tokens, 'siemens-brand');
@include themes.make-theme(brand-dark.$tokens, 'siemens-brand', true);
```

## Step 6 - Start the application

Now you should be ready to start the application with Element. Go to the project
directory and launch the server.
Expand Down
Loading