Skip to content

Commit

Permalink
docs(config): add some simple docs for limel-config
Browse files Browse the repository at this point in the history
`limel-config` is marked as private, but is linked to from the docs
about how to provide your own icon library.
  • Loading branch information
adrianschmidt committed Feb 14, 2024
1 parent 49d74b4 commit 6f4148f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
2 changes: 0 additions & 2 deletions etc/lime-elements.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,6 @@ export namespace Components {
"required": boolean;
"value": string;
}
// (undocumented)
export interface LimelConfig {
"config": Config;
}
Expand Down Expand Up @@ -1056,7 +1055,6 @@ namespace JSX_2 {
"required"?: boolean;
"value"?: string;
}
// (undocumented)
interface LimelConfig {
"config"?: Config;
}
Expand Down
12 changes: 12 additions & 0 deletions src/components/config/config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@ import { Component, Prop } from '@stencil/core';
import { Config, globalConfig } from '../../global/config';

/**
* Component used to set global configuration for Lime Elements.
*
* :::warning
* **Building something for Lime CRM?** Then you should _NOT_ use this component.
* Lime CRM already uses this component to set the global configuration for
* Lime Elements. No matter what problem you are facing at the moment, using
* this component will not help, and might cause other problems.
* :::
*
* Building your own software, which is using Lime Elements?
* Then you _might_ need to use this component.
*
* @private
*/
@Component({
Expand Down

0 comments on commit 6f4148f

Please sign in to comment.