Skip to content

Improve package info for NPM #9

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

Merged
philipsens merged 4 commits into from
Dec 24, 2024
Merged

Improve package info for NPM #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fbc1b4b
Add readme for npmjs
Matthbo Dec 24, 2024
f764137
Add git & homepage info to package.json
Matthbo Dec 24, 2024
a8df7a6
Update homepage in angular-components/package.json
Matthbo Dec 24, 2024
cc0cd05
Mention FF!Reference instead of the old name
Matthbo Dec 24, 2024
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
8 changes: 7 additions & 1 deletion projects/angular-components/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
{
"name": "@frankframework/angular-components",
"version": "1.0.0",
"version": "1.0.1",
"description": "A collection of reusable components designed for use in Frank!Framework projects",
"main": "",
"author": "Vivy Booman",
"license": "Apache-2.0",
"homepage": "https://frankframework.org",
"repository": {
"type": "git",
"url": "https://github.com/frankframework/angular-components.git",
"directory": "projects/angular-components"
},
"exports": {
".": {
"sass": "./_index.scss"
Expand Down
25 changes: 25 additions & 0 deletions projects/angular-components/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Angular Components

A collection of reusable components designed for use in Frank!Framework projects, based on new proposed FF!Reference designs.

## How to use
Install the package from NPM (coming soon)
```sh
npm install @frankframework/angular-components
```

Then import one of the components that you'd like to use or import the `LibraryModule` into the component(s) that needs to use it.

Import the stylesheet into `styles.scss` using:
```scss
@use '@frankframework/angular-components';
```

### Dark theme
The dark theme is set up to work whenever `<body class="ff-dark-theme">` is present on the HTML document.
But if you'd like to have it work under a custom classname then you should add this to your `styles.scss`:
```scss
body.custom-name {
@import '@frankframework/angular-components/styles/dark_theme';
}
```