@genesislcap/web-core 14.407.0 → 14.408.0-icon-renderer.3

package/README.md

@@ -1,60 +1,18 @@
-# Genesis Foundation Web Core
+# @genesislcap/web-core
 
-[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
-[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
+Documentation for this package is published on the Genesis docs site:
 
-`foundation-web-core` re-exports FAST classes.
-
-## [API Docs](./docs/api/index.md)
+**Docs: [Custom components](https://docs.genesis.global/docs/develop/client-capabilities/custom-components/)**
 
 ## Installation
 
-```sh
-npm i @genesislcap/foundation-web-core
-```
-
-## Features
-
-### Re-exported FAST Packages
-
-This package re-exports the following Microsoft FAST packages:
-
-- **fast-colors**: Provides color utilities and color system support.
-- **fast-components**: Collection of web components designed according to the FAST Design System.
-- **fast-element**: Lightweight base class for creating custom elements.
-- **fast-foundation**: Provides foundational behaviors and utilities for web components.
-- **fast-router**: Router implementation for single-page applications.
-- **fast-web-utilities**: Collection of utility functions for web component development.
-
-### Directives
-
-Additionally, this package exports a `directives` folder containing the following files:
-
-- **sync.ts**: Implementation of a directive for synchronous data binding.
-- **when-else.ts**: Implementation of a directive for conditional rendering using `whenElse` clause.
-
-## Usage
-
-To utilize the features provided by this package, you can import `@genesislcap/foundation-web-core`.
-
-```typescript
-import { css, customElement, FASTElement, html, sync } from '@genesislcap/foundation-web-core';
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 
-@customElement({
-  name: 'my-custom-element',
-  template: html`
-    <other-custom-element
-      value="${sync((x) => x.syncedValue)}"
-    ></other-custom-element>
-  `,
-  styles: css`
-    :host {
-      ...
-    }
-  `,
-})
-export class MyCustomElement extends FASTElement { 
-  ...
+```json
+{
+  "dependencies": {
+    "@genesislcap/web-core": "latest"
+  }
 }
 ```
 

package/package.json

@@ -1,19 +1,18 @@
 {
   "name": "@genesislcap/web-core",
   "description": "Genesis Foundation Web Core",
-  "version": "14.407.0",
+  "version": "14.408.0-icon-renderer.3",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
   "types": "dist/dts/index.d.ts",
   "scripts": {
     "api:extract": "api-extractor run",
-    "api:document": "api-documenter markdown -i dist -o docs/api",
     "build": "genx build -b ts && npm run build:webpack",
     "build:webpack": "genx build",
     "circular": "npx -y madge --extensions ts --circular ./src",
     "clean": "rimraf dist temp tsconfig.tsbuildinfo",
-    "dev": "tsc -b ./tsconfig.json -w",
+    "dev": "genx dev -b ts",
     "lint": "genx lint --profile",
     "lint:fix": "genx lint --fix"
   },
@@ -40,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7fda36618f710de9fce350d03fd861190fb6da04"
+  "gitHead": "81f085b26288c4eae01e17a47174d1e389c3a188"
 }

package/docs/api/index.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md)
-
-## API Reference
-
-## Packages
-
-<table><thead><tr><th>
-
-Package
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[@genesislcap/web-core](./web-core.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/web-core.conversiontype.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/web-core](./web-core.md) &gt; [ConversionType](./web-core.conversiontype.md)
-
-## ConversionType type
-
-Represents the possible types of value conversion for data synchronization.
-
-**Signature:**
-
-```typescript
-export type ConversionType = 'string' | 'number' | 'time' | 'boolean';
-```

package/docs/api/web-core.defaulteventmap.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/web-core](./web-core.md) &gt; [defaultEventMap](./web-core.defaulteventmap.md)
-
-## defaultEventMap variable
-
-A map that associates specific HTML element tags with their corresponding default event names.
-
-**Signature:**
-
-```typescript
-defaultEventMap: Map<string, EventName>
-```

package/docs/api/web-core.definefactory.md

@@ -1,99 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/web-core](./web-core.md) &gt; [defineFactory](./web-core.definefactory.md)
-
-## defineFactory() function
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Defines a platform custom element based on the provided type and definition.
-
-**Signature:**
-
-```typescript
-defineFactory: <TType extends Constructable<GenesisElement>>(Type: TType, overriderOrBase: DefinitionOverrider | PartialGenesisElementDefinition) => DefineFunction<TType>
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-Type
-
-
-</td><td>
-
-TType
-
-
-</td><td>
-
-The custom element Type / Class to define.
-
-
-</td></tr>
-<tr><td>
-
-overriderOrBase
-
-
-</td><td>
-
-[DefinitionOverrider](./web-core.definitionoverrider.md) \| PartialGenesisElementDefinition
-
-
-</td><td>
-
-A function that merges definitions, or the base definition if custom merging is not needed.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[DefineFunction](./web-core.definefunction.md)<!-- -->&lt;TType&gt;
-
-The type class.
-
-## Example 1
-
-An example using custom definition merge logic, useful if you need to impose hard restrictions.
-
-```ts
-const definitionOverrider = (definition) => ({
-   ...baseDefinition,
-   ...definition,
-   styles: baseDefinition.styles,
-   shadowOptions: {
-     mode: 'closed,
-   },
-});
-export const define = defineFactory(LoginForm, definitionOverrider);
-```
-
-## Example 2
-
-You can provide the base definition if you're happy with the default spread operator merge logic.
-
-```ts
-export const define = defineFactory(LoginForm, baseDefinition);
-```
-

package/docs/api/web-core.definefunction.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/web-core](./web-core.md) &gt; [DefineFunction](./web-core.definefunction.md)
-
-## DefineFunction type
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-
-**Signature:**
-
-```typescript
-export type DefineFunction<TType> = (definition: PartialGenesisElementDefinition) => TType;
-```

package/docs/api/web-core.definitionoverrider.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/web-core](./web-core.md) &gt; [DefinitionOverrider](./web-core.definitionoverrider.md)
-
-## DefinitionOverrider type
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-
-**Signature:**
-
-```typescript
-export type DefinitionOverrider = (override: PartialGenesisElementDefinition) => PartialGenesisElementDefinition;
-```

package/docs/api/web-core.deprecatedattr.md

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/web-core](./web-core.md) &gt; [deprecatedAttr](./web-core.deprecatedattr.md)
-
-## deprecatedAttr() function
-
-Decorator: Specifies an HTML attribute.
-
-**Signature:**
-
-```typescript
-export declare function deprecatedAttr(config?: ExtendedDecoratorAttributeConfiguration): (target: {}, property: string) => void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-config
-
-
-</td><td>
-
-ExtendedDecoratorAttributeConfiguration
-
-
-</td><td>
-
-_(Optional)_ The configuration for the attribute.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-(target: {}, property: string) =&gt; void
-

package/docs/api/web-core.deprecatedattr_1.md

@@ -1,70 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/web-core](./web-core.md) &gt; [deprecatedAttr](./web-core.deprecatedattr_1.md)
-
-## deprecatedAttr() function
-
-Decorator: Specifies an HTML attribute.
-
-**Signature:**
-
-```typescript
-export declare function deprecatedAttr(target: {}, prop: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-target
-
-
-</td><td>
-
-{}
-
-
-</td><td>
-
-The class to define the attribute on.
-
-
-</td></tr>
-<tr><td>
-
-prop
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The property name to be associated with the attribute.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/web-core.eventname.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/web-core](./web-core.md) &gt; [EventName](./web-core.eventname.md)
-
-## EventName type
-
-Represents the possible event names for data synchronization.
-
-**Signature:**
-
-```typescript
-export type EventName = 'input' | 'change' | 'default';
-```

package/docs/api/web-core.md

@@ -1,194 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/web-core](./web-core.md)
-
-## web-core package
-
-## Functions
-
-<table><thead><tr><th>
-
-Function
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[defineFactory(Type, overriderOrBase)](./web-core.definefactory.md)
-
-
-</td><td>
-
-**_(BETA)_** Defines a platform custom element based on the provided type and definition.
-
-
-</td></tr>
-<tr><td>
-
-[deprecatedAttr(config)](./web-core.deprecatedattr.md)
-
-
-</td><td>
-
-Decorator: Specifies an HTML attribute.
-
-
-</td></tr>
-<tr><td>
-
-[deprecatedAttr(target, prop)](./web-core.deprecatedattr_1.md)
-
-
-</td><td>
-
-Decorator: Specifies an HTML attribute.
-
-
-</td></tr>
-<tr><td>
-
-[sync(binding, conversionType, eventName, keyAttr)](./web-core.sync.md)
-
-
-</td><td>
-
-Creates a synchronization directive that binds a data source to an HTML element,
-
-
-</td></tr>
-<tr><td>
-
-[tagFor(dependency)](./web-core.tagfor.md)
-
-
-</td><td>
-
-**_(BETA)_** Determines what HTML tag name to use for the dependency.
-
-
-</td></tr>
-<tr><td>
-
-[whenElse(binding, trueTemplateOrTemplateBinding, falseTemplateOrTemplateBinding)](./web-core.whenelse.md)
-
-
-</td><td>
-
-Directive that allows supplying an "else" template to the traditional [https://www.fast.design/docs/api/fast-element.when/\#when-function](https://www.fast.design/docs/api/fast-element.when/#when-function) directive
-
-
-</td></tr>
-</tbody></table>
-
-## Variables
-
-<table><thead><tr><th>
-
-Variable
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[defaultEventMap](./web-core.defaulteventmap.md)
-
-
-</td><td>
-
-A map that associates specific HTML element tags with their corresponding default event names.
-
-
-</td></tr>
-</tbody></table>
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ConversionType](./web-core.conversiontype.md)
-
-
-</td><td>
-
-Represents the possible types of value conversion for data synchronization.
-
-
-</td></tr>
-<tr><td>
-
-[DefineFunction](./web-core.definefunction.md)
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[DefinitionOverrider](./web-core.definitionoverrider.md)
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[EventName](./web-core.eventname.md)
-
-
-</td><td>
-
-Represents the possible event names for data synchronization.
-
-
-</td></tr>
-<tr><td>
-
-[TemplateElementDependency](./web-core.templateelementdependency.md)
-
-
-</td><td>
-
-**_(BETA)_** Used to designate a template's dependency on another custom element.
-
-
-</td></tr>
-<tr><td>
-
-[TemplateElements](./web-core.templateelements.md)
-
-
-</td><td>
-
-**_(BETA)_** Used to help map components / elements for tagFor usage
-
-
-</td></tr>
-</tbody></table>
-