@laserfiche/lf-ui-components-services

lf-ui-components-services

This library contains the data sources implementation to connect the Laserfiche UI Components to live data from Laserfiche API services.

You can use these pre-built services to display data using the UI components.

Documentation

Getting started

1. npm install @laserfiche/lf-ui-components-services

2. Create an instance of IRepositoryClientEx. See IRepositoryClient documentation to create partialRepoClient.

   const partialRepoClient = IRepositoryClient.createFromHttpHandler({...});
   const repositoryClient: IRepositoryClientEx = {
       ...partialRepoClient,
       getCurrentRepoId: async () => {return await partialRepoClient.repositoriesClient.getRepositoryInfo()[0].repoId},
       getCurrentRepoName: async () => {return await partialRepoClient.repositoriesClient.getRepositoryInfo()[0].repoName},
   }

3. Initialize your chosen service

   const fieldsService = new LfFieldsService(repositoryClient);

4. Use service with the corresponding UI Component

   await this.metadataContainer.initAsync({fieldsService});

For detailed information about how to utilize these services see the sample projects available in Github (in Angular and React)

Change Log

See CHANGELOG here.

Contribution

We welcome contributions and feedback. Please follow our contributing guidelines.

Development prerequisite

See .github/workflows/main.yml for Node and NPM version used.