@arkitektum/altinn-studio-custom-components
v14.0.2
Published
Custom components for Altinn Studio
Downloads
2,062
Readme
altinn-studio-custom-components
A collection of reusable custom components for Altinn Studio, designed to provide consistent, standardized presentation of various data types in digital public services.
📦 Installation
To integrate this package into your Altinn Studio application, follow the steps below.
1. Initialize npm
npm init -y2. Install the package
npm install @arkitektum/altinn-studio-custom-components --save3. Configure asset handling in /App/App.csproj
Add the following snippet to ensure npm packages are installed and
copied to wwwroot during the build:
<Target Name="NpmInstall" Inputs="package.json" Outputs="node_modules/.install-stamp">
<Exec Command="npm ci" Condition="'$(RestorePackagesWithLockFile)' == 'true'" />
<Exec Command="npm install" Condition="'$(RestorePackagesWithLockFile)' != 'true'" />
<Touch Files="node_modules/.install-stamp" AlwaysCreate="true" />
</Target>
<ItemGroup>
<MyAssets Include="node_modules/@arkitektum/altinn-studio-custom-components/**/*.*" />
</ItemGroup>
<Target Name="CopyAssetsToWwwroot" DependsOnTargets="NpmInstall" AfterTargets="Build">
<Message Text="Copying assets to wwwroot..." Importance="High" />
<MakeDir Directories="wwwroot/altinn-studio-custom-components" />
<Copy
SourceFiles="@(MyAssets)"
DestinationFolder="wwwroot/altinn-studio-custom-components"
SkipUnchangedFiles="true" />
</Target>4. Include the scripts and styles in /views/Home/index.cshtml
Replace [ORG NAME] and [APP NAME] with the correct values:
<html>
<head>
<link rel="stylesheet" type="text/css" href="/[ORG NAME]/[APP NAME]/altinn-studio-custom-components/main.css" />
</head>
<body>
<script type="module" src="/[ORG NAME]/[APP NAME]/altinn-studio-custom-components/main.js"></script>
</body>
</html>5. Add npm support in your Dockerfile
WORKDIR /App
RUN apk add --no-cache npmAfter these steps, npm packages will be installed automatically during
the build, and all assets will be copied into
wwwroot/altinn-studio-custom-components.
🧩 Available Components
Components are grouped by category and tailored to display domain-specific data according to standards from Direktoratet for Byggkvalitet (DiBK) on the Fellestjenester BYGG platform.
For a full list of available components and examples, see the documentation site:
Component Documentation & Gallery
🧪 Development & Testing
Development
Clone the repository:
git clone https://github.com/Arkitektum/altinn-studio-custom-components.gitMove into the project directory:
cd altinn-studio-custom-componentsInstall dependencies:
yarn installStart the development server:
yarn start
Testing
Run unit tests:
yarn test🔗 Resources
- Altinn Studio Documentation
- Altinn Studio GitHub Repository
- Altinn Studio Customm Component Documentation
- POC: Use of third party components in apps
📝 Changelog
The changelog is regularly updated to reflect what's changed in each new release.
