igniteui-cli 15.8.1 → 15.8.3-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/MultiTemplateComponent.d.ts +1 -1
- package/lib/TemplateManager.d.ts +1 -1
- package/lib/cli.d.ts +1 -1
- package/lib/cli.js +2 -2
- package/lib/commands/doc.js +1 -1
- package/lib/commands/list.js +1 -1
- package/lib/commands/types.d.ts +2 -2
- package/lib/commands/upgrade.js +4 -1
- package/lib/project-utility/GridHelper.d.ts +6 -2
- package/lib/templates/IgniteUIForReactTemplate.d.ts +9 -5
- package/lib/templates/IgniteUIForReactTemplate.js +2 -2
- package/lib/templates/IgniteUIForWebComponentsTemplate.d.ts +8 -4
- package/lib/templates/IgniteUIForWebComponentsTemplate.js +8 -4
- package/lib/templates/jQueryTemplate.d.ts +8 -4
- package/lib/templates/jQueryTemplate.js +1 -1
- package/package.json +5 -4
- package/templates/blazor/igb/projects/ai-config/files/skills/AGENTS.md +7 -2
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/client-scripts.md +7 -7
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/data-display.md +2 -2
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/form-controls.md +65 -18
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-components/references/setup.md +2 -2
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-generate-from-image-design/references/component-mapping.md +5 -5
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-generate-from-image-design/references/gotchas.md +24 -5
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/SKILL.md +1 -1
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/editing.md +4 -3
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/grid-migration.md +1 -1
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-grids/references/types.md +1 -1
- package/templates/blazor/igb/projects/ai-config/files/skills/igniteui-blazor-theming/references/common-patterns.md +1 -1
- package/templates/blazor/igb/projects/ai-config/index.d.ts +1 -1
- package/templates/blazor/igb/projects/ai-config/index.js +1 -0
- package/templates/blazor/igb/projects/empty/index.d.ts +1 -1
- package/templates/jquery/js/projects/empty/index.js +1 -0
- package/templates/react/ReactTypeScriptFileUpdate.js +4 -4
- package/templates/react/igr-ts/constants.d.ts +1 -1
- package/templates/react/igr-ts/constants.js +1 -1
- package/templates/react/igr-ts/projects/_base/index.d.ts +1 -1
- package/templates/react/igr-ts/projects/_base/index.js +1 -0
- package/templates/react/igr-ts/projects/ai-config/index.d.ts +1 -1
- package/templates/webcomponents/WebComponentsTypeScriptFileUpdate.js +2 -2
- package/templates/webcomponents/igc-ts/category-chart/default/files/src/app/__path__/__filePrefix__.test.ts +9 -0
- package/templates/webcomponents/igc-ts/category-chart/default/files/src/app/__path__/__filePrefix__.ts +37 -0
- package/templates/webcomponents/igc-ts/category-chart/default/index.d.ts +1 -0
- package/templates/webcomponents/igc-ts/category-chart/default/index.js +21 -0
- package/templates/webcomponents/igc-ts/category-chart/index.d.ts +1 -0
- package/templates/webcomponents/igc-ts/category-chart/index.js +12 -0
- package/templates/webcomponents/igc-ts/constants.d.ts +1 -1
- package/templates/webcomponents/igc-ts/constants.js +1 -1
- package/templates/webcomponents/igc-ts/doughnut-chart/default/files/src/app/__path__/__filePrefix__.test.ts +9 -0
- package/templates/webcomponents/igc-ts/doughnut-chart/default/files/src/app/__path__/__filePrefix__.ts +52 -0
- package/templates/webcomponents/igc-ts/doughnut-chart/default/index.d.ts +1 -0
- package/templates/webcomponents/igc-ts/doughnut-chart/default/index.js +21 -0
- package/templates/webcomponents/igc-ts/doughnut-chart/index.d.ts +1 -0
- package/templates/webcomponents/igc-ts/doughnut-chart/index.js +12 -0
- package/templates/webcomponents/igc-ts/projects/_base/index.d.ts +4 -2
- package/templates/webcomponents/igc-ts/projects/_base_with_home/files/package.json +1 -1
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/README.md +15 -15
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-choose-components/SKILL.md +36 -36
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-choose-components/reference/mcp-setup.md +8 -6
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-customize-component-theme/SKILL.md +62 -60
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-customize-component-theme/references/mcp-setup.md +8 -6
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/SKILL.md +107 -94
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/asset-extraction.md +32 -32
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/design-provenance.md +32 -30
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/design-token-bridge.md +84 -71
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/figma-component-map.md +45 -44
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/figma-exploration.md +57 -51
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/mcp-setup.md +23 -23
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/project-setup.md +28 -26
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/theme-generation.md +45 -35
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-figma-to-app/references/validation-patterns.md +38 -29
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-generate-from-image-design/SKILL.md +63 -63
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-generate-from-image-design/references/component-mapping.md +12 -12
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-generate-from-image-design/references/gotchas.md +24 -24
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-grids/SKILL.md +23 -23
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-integrate-with-framework/SKILL.md +23 -23
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-integrate-with-framework/references/angular.md +10 -10
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-integrate-with-framework/references/react.md +9 -9
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-integrate-with-framework/references/vanilla-js.md +9 -9
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-integrate-with-framework/references/vue.md +11 -11
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-migrate-grid-lite-to-premium/SKILL.md +18 -18
- package/templates/webcomponents/igc-ts/projects/ai-config/files/skills/igniteui-wc-optimize-bundle-size/SKILL.md +78 -48
- package/templates/webcomponents/igc-ts/projects/ai-config/index.d.ts +1 -1
- package/templates/webcomponents/igc-ts/projects/ai-config/index.js +1 -0
|
@@ -7,7 +7,7 @@ export declare abstract class MultiTemplateComponent<T extends Template> impleme
|
|
|
7
7
|
description: string;
|
|
8
8
|
groupPriority: number;
|
|
9
9
|
get templates(): T[];
|
|
10
|
-
constructor(testType:
|
|
10
|
+
constructor(testType: new () => T, templatesMap: Map<string, {
|
|
11
11
|
name: string;
|
|
12
12
|
widget: string;
|
|
13
13
|
}>);
|
package/lib/TemplateManager.d.ts
CHANGED
|
@@ -6,5 +6,5 @@ export declare class TemplateManager extends BaseTemplateManager {
|
|
|
6
6
|
* @param filePath Path to a json config file representing a template
|
|
7
7
|
* @returns null if no proper file is found
|
|
8
8
|
*/
|
|
9
|
-
protected loadFromConfig(filePath: string): Template;
|
|
9
|
+
protected loadFromConfig(filePath: string): Template | null;
|
|
10
10
|
}
|
package/lib/cli.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare function run(args
|
|
1
|
+
export declare function run(args: string | string[]): Promise<void>;
|
package/lib/cli.js
CHANGED
|
@@ -25,8 +25,8 @@ function logHelp() {
|
|
|
25
25
|
cd: "$ig help"
|
|
26
26
|
});
|
|
27
27
|
}
|
|
28
|
-
function run() {
|
|
29
|
-
return __awaiter(this,
|
|
28
|
+
function run(args) {
|
|
29
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
30
30
|
cli_core_1.App.initialize();
|
|
31
31
|
const templateManager = new TemplateManager_1.TemplateManager();
|
|
32
32
|
cli_core_1.App.container.set(cli_core_1.TEMPLATE_MANAGER, templateManager);
|
package/lib/commands/doc.js
CHANGED
|
@@ -46,7 +46,7 @@ const doc = {
|
|
|
46
46
|
},
|
|
47
47
|
open: (target) => __awaiter(void 0, void 0, void 0, function* () {
|
|
48
48
|
const open = yield Promise.resolve().then(() => __importStar(require("open")));
|
|
49
|
-
open.default
|
|
49
|
+
yield open.default(target);
|
|
50
50
|
}),
|
|
51
51
|
handler(argv) {
|
|
52
52
|
return __awaiter(this, void 0, void 0, function* () {
|
package/lib/commands/list.js
CHANGED
|
@@ -40,7 +40,7 @@ const command = {
|
|
|
40
40
|
}
|
|
41
41
|
return listAllFrameworks();
|
|
42
42
|
}
|
|
43
|
-
const templatesByGroup =
|
|
43
|
+
const templatesByGroup = {};
|
|
44
44
|
const controlGroups = [];
|
|
45
45
|
const templateManager = cli_core_1.App.container.get(cli_core_1.TEMPLATE_MANAGER);
|
|
46
46
|
const framework = templateManager.getFrameworkById(argv.framework);
|
package/lib/commands/types.d.ts
CHANGED
|
@@ -30,7 +30,7 @@ export interface PositionalArgs {
|
|
|
30
30
|
}
|
|
31
31
|
export interface CommandType extends CommandModule<{}, any> {
|
|
32
32
|
/** Handler function that will be called by yargs after the command line has been parsed. */
|
|
33
|
-
handler(/** do not use `this` in handler */ this: void, argv: ArgumentsCamelCase<PositionalArgs>):
|
|
33
|
+
handler(/** do not use `this` in handler */ this: void, argv: ArgumentsCamelCase<PositionalArgs>): void | Promise<void>;
|
|
34
34
|
}
|
|
35
35
|
export interface NewCommandType extends CommandType {
|
|
36
36
|
/** Adds choices to the `builder.framework` option. */
|
|
@@ -62,7 +62,7 @@ export interface ConfigCommandType extends CommandType {
|
|
|
62
62
|
}
|
|
63
63
|
export interface DocCommandType extends CommandType {
|
|
64
64
|
/** Uses the `open` package to open a URL, file etc. */
|
|
65
|
-
open(
|
|
65
|
+
open(target: string): void;
|
|
66
66
|
}
|
|
67
67
|
export interface TestCommandType extends CommandType {
|
|
68
68
|
/** Executes tests. */
|
package/lib/commands/upgrade.js
CHANGED
|
@@ -66,7 +66,10 @@ const command = {
|
|
|
66
66
|
if (projectType === "igx-ts" || projectType === "igr-ts" || projectType === "igc-ts") {
|
|
67
67
|
const templateManager = cli_core_1.App.container.get(cli_core_1.TEMPLATE_MANAGER);
|
|
68
68
|
const projectLibrary = templateManager.getProjectLibrary(framework, projectType);
|
|
69
|
-
|
|
69
|
+
// a framework and project type that don't match each other resolve to no library
|
|
70
|
+
const project = projectLibrary
|
|
71
|
+
? (0, cli_core_1.resolveUpgradeableProject)(projectLibrary, (_c = config.project) === null || _c === void 0 ? void 0 : _c.projectTemplate)
|
|
72
|
+
: null;
|
|
70
73
|
if (!project) {
|
|
71
74
|
cli_core_1.Util.error("No valid Ignite UI project template found to upgrade packages.", "red");
|
|
72
75
|
return;
|
|
@@ -21,8 +21,12 @@ export declare class GridHelper {
|
|
|
21
21
|
*/
|
|
22
22
|
constructor();
|
|
23
23
|
generateFeatures(gridFeatures: string[], pad?: number): string;
|
|
24
|
-
addFeature(name:
|
|
25
|
-
|
|
24
|
+
addFeature(name: string, overrideOptions?: {
|
|
25
|
+
[key: string]: unknown;
|
|
26
|
+
} | null): void;
|
|
27
|
+
updateFeature(name: string, overrideOptions: {
|
|
28
|
+
[key: string]: unknown;
|
|
29
|
+
}): void;
|
|
26
30
|
/**
|
|
27
31
|
* Returns and object like `{name: "feature"}` with any other default properties
|
|
28
32
|
* @param name Feature name
|
|
@@ -13,21 +13,25 @@ export declare class IgniteUIForReactTemplate implements Template {
|
|
|
13
13
|
projectType: string;
|
|
14
14
|
hasExtraConfiguration: boolean;
|
|
15
15
|
isHidden: boolean;
|
|
16
|
-
packages:
|
|
17
|
-
delimiters: import("@igniteui/cli-core").TemplateDelimiters
|
|
18
|
-
protected widget
|
|
16
|
+
packages: string[];
|
|
17
|
+
delimiters: Required<import("@igniteui/cli-core").TemplateDelimiters>;
|
|
18
|
+
protected widget?: string;
|
|
19
19
|
/**
|
|
20
20
|
* Base ReactTemplate constructor
|
|
21
21
|
* @param rootPath The template folder path. Pass in `__dirname`
|
|
22
22
|
*/
|
|
23
23
|
constructor(rootPath: string);
|
|
24
24
|
get templatePaths(): string[];
|
|
25
|
-
generateConfig(name: string, options
|
|
25
|
+
generateConfig(name: string, options?: {
|
|
26
|
+
[key: string]: any;
|
|
27
|
+
}): {
|
|
26
28
|
[key: string]: any;
|
|
27
29
|
};
|
|
28
30
|
registerInProject(projectPath: string, name: string, options?: AddTemplateArgs, defaultPath?: boolean): void;
|
|
29
31
|
getExtraConfiguration(): ControlExtraConfiguration[];
|
|
30
|
-
setExtraConfiguration(extraConfigKeys: {
|
|
32
|
+
setExtraConfiguration(extraConfigKeys: {
|
|
33
|
+
[key: string]: unknown;
|
|
34
|
+
}): void;
|
|
31
35
|
protected folderName(pathName: string): string;
|
|
32
36
|
protected fileName(pathName: string): string;
|
|
33
37
|
}
|
|
@@ -47,7 +47,7 @@ class IgniteUIForReactTemplate {
|
|
|
47
47
|
get templatePaths() {
|
|
48
48
|
return [path.join(this.rootPath, "files")];
|
|
49
49
|
}
|
|
50
|
-
generateConfig(name, options) {
|
|
50
|
+
generateConfig(name, options = {}) {
|
|
51
51
|
let config = {};
|
|
52
52
|
if (options["extraConfig"]) {
|
|
53
53
|
config = options["extraConfig"];
|
|
@@ -66,7 +66,7 @@ class IgniteUIForReactTemplate {
|
|
|
66
66
|
}
|
|
67
67
|
return config;
|
|
68
68
|
}
|
|
69
|
-
registerInProject(projectPath, name, options, defaultPath = false) {
|
|
69
|
+
registerInProject(projectPath, name, options = {}, defaultPath = false) {
|
|
70
70
|
if (!options.parentName) {
|
|
71
71
|
options.parentName = "app";
|
|
72
72
|
}
|
|
@@ -12,17 +12,21 @@ export declare class IgniteUIForWebComponentsTemplate implements Template {
|
|
|
12
12
|
projectType: string;
|
|
13
13
|
hasExtraConfiguration: boolean;
|
|
14
14
|
isHidden: boolean;
|
|
15
|
-
packages:
|
|
15
|
+
packages: string[];
|
|
16
16
|
dependencies: TemplateDependency[];
|
|
17
|
-
delimiters: import("@igniteui/cli-core").TemplateDelimiters
|
|
17
|
+
delimiters: Required<import("@igniteui/cli-core").TemplateDelimiters>;
|
|
18
18
|
get templatePaths(): string[];
|
|
19
19
|
constructor(rootPath: string);
|
|
20
|
-
generateConfig(name: string, options
|
|
20
|
+
generateConfig(name: string, options?: {
|
|
21
|
+
[key: string]: any;
|
|
22
|
+
}): {
|
|
21
23
|
[key: string]: any;
|
|
22
24
|
};
|
|
23
25
|
registerInProject(projectPath: string, fullName: string, options?: AddTemplateArgs, defaultPath?: boolean): void;
|
|
24
26
|
getExtraConfiguration(): ControlExtraConfiguration[];
|
|
25
|
-
setExtraConfiguration(extraConfigKeys: {
|
|
27
|
+
setExtraConfiguration(extraConfigKeys: {
|
|
28
|
+
[key: string]: unknown;
|
|
29
|
+
}): void;
|
|
26
30
|
protected getBaseVariables(name: string): {
|
|
27
31
|
[key: string]: string;
|
|
28
32
|
};
|
|
@@ -43,21 +43,24 @@ class IgniteUIForWebComponentsTemplate {
|
|
|
43
43
|
this.dependencies = [];
|
|
44
44
|
this.delimiters = cli_core_1.defaultDelimiters;
|
|
45
45
|
}
|
|
46
|
-
generateConfig(name, options) {
|
|
46
|
+
generateConfig(name, options = {}) {
|
|
47
47
|
if (options["modulePath"] && !cli_core_1.Util.fileExists(path.join(process.cwd(), `src\\app`, options["modulePath"]))) {
|
|
48
48
|
cli_core_1.Util.error(`Wrong module path provided: ${options["modulePath"]}. No components were added!`);
|
|
49
49
|
return Promise.resolve(false);
|
|
50
50
|
}
|
|
51
51
|
return Object.assign({}, options["extraConfig"], this.getBaseVariables(name));
|
|
52
52
|
}
|
|
53
|
-
registerInProject(projectPath, fullName, options, defaultPath = false) {
|
|
53
|
+
registerInProject(projectPath, fullName, options = {}, defaultPath = false) {
|
|
54
54
|
if (!options.parentName) {
|
|
55
|
-
|
|
55
|
+
options.parentName = "app";
|
|
56
|
+
}
|
|
57
|
+
if (!options.parentRoutingModulePath) {
|
|
58
|
+
options.parentRoutingModulePath = "src/app/app-routing.ts";
|
|
56
59
|
}
|
|
57
60
|
const routeModulePath = options.parentRoutingModulePath;
|
|
58
|
-
const routingModule = new WebComponentsTypeScriptFileUpdate_1.WebComponentsTypeScriptFileUpdate(path.join(projectPath, routeModulePath), { convertTabsToSpaces: true, indentSize: 2, singleQuotes: true });
|
|
59
61
|
if (!(options && options.skipRoute) &&
|
|
60
62
|
cli_core_1.App.container.get(cli_core_1.FS_TOKEN).fileExists(routeModulePath)) {
|
|
63
|
+
const routingModule = new WebComponentsTypeScriptFileUpdate_1.WebComponentsTypeScriptFileUpdate(path.join(projectPath, routeModulePath), { convertTabsToSpaces: true, indentSize: 2, singleQuotes: true });
|
|
61
64
|
const modulePath = `./${cli_core_1.Util.lowerDashed(fullName)}/${cli_core_1.Util.lowerDashed(fullName)}-routing`;
|
|
62
65
|
const componentTag = `app-${this.fileName(fullName)}`;
|
|
63
66
|
const child = {
|
|
@@ -101,6 +104,7 @@ class IgniteUIForWebComponentsTemplate {
|
|
|
101
104
|
config["filePrefix"] = this.fileName(name);
|
|
102
105
|
config["description"] = this.description;
|
|
103
106
|
config["cliVersion"] = cli_core_1.Util.version();
|
|
107
|
+
// component names are validated as non-empty before templates run
|
|
104
108
|
config["camelCaseName"] = cli_core_1.Util.camelCase(name);
|
|
105
109
|
config["dockManagerPackage"] = (0, cli_core_1.resolvePackage)(cli_core_1.NPM_DOCK_MANAGER);
|
|
106
110
|
return config;
|
|
@@ -16,13 +16,15 @@ export declare class jQueryTemplate implements Template {
|
|
|
16
16
|
projectType: string;
|
|
17
17
|
hasExtraConfiguration: boolean;
|
|
18
18
|
isHidden: boolean;
|
|
19
|
-
packages:
|
|
20
|
-
delimiters: import("@igniteui/cli-core").TemplateDelimiters
|
|
19
|
+
packages: string[];
|
|
20
|
+
delimiters: Required<import("@igniteui/cli-core").TemplateDelimiters>;
|
|
21
21
|
private configFile;
|
|
22
22
|
private replacePattern;
|
|
23
23
|
constructor(rootPath: string);
|
|
24
24
|
get templatePaths(): string[];
|
|
25
|
-
generateConfig(name: string, options
|
|
25
|
+
generateConfig(name: string, options?: {
|
|
26
|
+
[key: string]: any;
|
|
27
|
+
}): {
|
|
26
28
|
[key: string]: any;
|
|
27
29
|
};
|
|
28
30
|
/**
|
|
@@ -32,7 +34,9 @@ export declare class jQueryTemplate implements Template {
|
|
|
32
34
|
*/
|
|
33
35
|
registerInProject(projectPath: string, name: string, options?: AddTemplateArgs): void;
|
|
34
36
|
getExtraConfiguration(): ControlExtraConfiguration[];
|
|
35
|
-
setExtraConfiguration(extraConfigKeys: {
|
|
37
|
+
setExtraConfiguration(extraConfigKeys: {
|
|
38
|
+
[key: string]: unknown;
|
|
39
|
+
}): void;
|
|
36
40
|
protected getJqueryDependenciesScriptTag(): string;
|
|
37
41
|
protected getScriptTags(): string;
|
|
38
42
|
protected getNavigationScript(): string;
|
|
@@ -46,7 +46,7 @@ class jQueryTemplate {
|
|
|
46
46
|
get templatePaths() {
|
|
47
47
|
return [path.join(this.rootPath, "files")];
|
|
48
48
|
}
|
|
49
|
-
generateConfig(name, options) {
|
|
49
|
+
generateConfig(name, options = {}) {
|
|
50
50
|
let config = {};
|
|
51
51
|
if (options["extraConfig"]) {
|
|
52
52
|
config = options["extraConfig"];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "igniteui-cli",
|
|
3
|
-
"version": "15.8.
|
|
3
|
+
"version": "15.8.3-alpha.0",
|
|
4
4
|
"description": "CLI tool for creating Ignite UI projects",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"CLI",
|
|
@@ -66,9 +66,9 @@
|
|
|
66
66
|
"all": true
|
|
67
67
|
},
|
|
68
68
|
"dependencies": {
|
|
69
|
-
"@igniteui/angular-templates": "~22.2.
|
|
70
|
-
"@igniteui/cli-core": "~15.8.
|
|
71
|
-
"@igniteui/mcp-server": "~15.8.
|
|
69
|
+
"@igniteui/angular-templates": "~22.2.1583-alpha.0",
|
|
70
|
+
"@igniteui/cli-core": "~15.8.3-alpha.0",
|
|
71
|
+
"@igniteui/mcp-server": "~15.8.3-alpha.0",
|
|
72
72
|
"@inquirer/prompts": "^7.9.0",
|
|
73
73
|
"chalk": "^5.3.0",
|
|
74
74
|
"glob": "^11.0.0",
|
|
@@ -84,6 +84,7 @@
|
|
|
84
84
|
"@schematics/angular": "^22.0.0",
|
|
85
85
|
"@types/jasmine": "^5.1.4",
|
|
86
86
|
"@types/node": "^22.5.5",
|
|
87
|
+
"@types/resolve": "^1.20.6",
|
|
87
88
|
"@types/yargs": "^17.0.33",
|
|
88
89
|
"browser-sync": "^3.0.3",
|
|
89
90
|
"coveralls-next": "^4.2.1",
|
|
@@ -58,7 +58,12 @@ You are an expert in C#, Blazor, and scalable web application development. You w
|
|
|
58
58
|
## UI Components — Ignite UI for Blazor
|
|
59
59
|
|
|
60
60
|
- **Packages**: `IgniteUI.Blazor.Lite` for general-purpose components and `IgniteUI.Blazor.GridLite` for the lightweight grid (both MIT, NuGet.org); `IgniteUI.Blazor` — publicly available for evaluation as `IgniteUI.Blazor.Trial` — for feature-rich grids, charts, maps, gauges, and Dock Manager. If the project already references the full `IgniteUI.Blazor`, do not add Lite or GridLite unless the user explicitly chooses to switch package strategy. If no Ignite UI package is present, add the one that matches the chosen strategy.
|
|
61
|
-
- **Setup**: `builder.Services.AddIgniteUIBlazor()` in `Program.cs`, `@using IgniteUI.Blazor.Controls` in `_Imports.razor`, and
|
|
62
|
-
- **
|
|
61
|
+
- **Setup**: `builder.Services.AddIgniteUIBlazor()` in `Program.cs`, `@using IgniteUI.Blazor.Controls` in `_Imports.razor`, and the theme stylesheet(s) in the host page (see **Theme stylesheets** below — full grids need two). `IgniteUI.Blazor.Lite` loads its scripts itself (JS initializer); the full `IgniteUI.Blazor`/`.Trial` also needs `_content/IgniteUI.Blazor/app.bundle.js` before the Blazor script in Blazor Web Apps (so the library's client resources initialize correctly there) — never wrapped in `@Assets[...]`.
|
|
62
|
+
- **Theme stylesheets** (the “one theme stylesheet” setup above excludes full grids, which require both stylesheets):
|
|
63
|
+
- Base theme: `_content/IgniteUI.Blazor/themes/<variant>/<theme>.css` (`<variant>` is `light` or `dark`; `<theme>` is `bootstrap`, `material`, `fluent`, or `indigo`).
|
|
64
|
+
- Full grids (`IgbGrid`, `IgbTreeGrid`, `IgbHierarchicalGrid`, `IgbPivotGrid`) also need `_content/IgniteUI.Blazor/themes/grid/<variant>/<theme>.css` in the same variant and theme. Without it the grid renders unstyled.
|
|
65
|
+
- `_content/IgniteUI.Blazor.GridLite/themes/<variant>/<theme>.css` is only for an app whose sole Ignite UI component is `IgbGridLite`. When other Ignite UI components are on the page, link the base theme instead and do not add the GridLite stylesheet.
|
|
66
|
+
- **Do not write Ignite UI component, property, or event names from memory** — the Blazor API differs from the Angular, React, and Web Components products. Use the `igniteui-cli` MCP server and the Ignite UI Blazor skills (`igniteui-blazor-components`, `igniteui-blazor-grids`, `igniteui-blazor-theming`) when they are installed. This file is meant to ship with those skills (https://github.com/IgniteUI/igniteui-blazor/tree/master/skills); if neither is available, use the official docs at https://www.infragistics.com/products/ignite-ui-blazor/blazor/components/general-getting-started.
|
|
67
|
+
- Handle `IgbButton` / `IgbIconButton` clicks with Blazor's `@onclick`; they have no `Click`/`OnClick` event parameter (`ClickAsync()` is a method that triggers a click programmatically).
|
|
63
68
|
- Prefer the `Async` form of component methods (`ShowAsync()`, not `Show()`); the sync twins require an in-process JS runtime and throw on Blazor Server.
|
|
64
69
|
- Style components with `--ig-*` design tokens on `igc-*` selectors, adding `::deep` in `.razor.css` files. Scope a theme to a page region with `IgbThemeProvider`.
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
Every component parameter ending in `Script` takes the **name** of a JavaScript function registered on the client, not code. Two kinds exist:
|
|
4
4
|
|
|
5
|
-
**Package scope.** The `api.js` module ships with `IgniteUI.Blazor.Lite`. The full product (`IgniteUI.Blazor` / `IgniteUI.Blazor.Trial`, grids, charts, Dock Manager) does not ship it yet: register there through the `igRegisterScript(name, fn, shouldCall)` window global, which its `app.bundle.js` script tag installs. Its `shouldCall` defaults to `true`, so pass `false` for handlers and templates.
|
|
6
|
-
|
|
7
5
|
| Kind | Examples | Function receives | Returns |
|
|
8
6
|
|---|---|---|---|
|
|
9
7
|
| Template | `ItemTemplateScript`, `GroupHeaderTemplateScript`, `MessageHeaderScript`, … | a context object | an `html` template result, a string, a primitive — anything lit can render |
|
|
10
8
|
| Event handler | `ChangeScript`, `ClosingScript`, `FocusScript`, … — one per C# event | the DOM `CustomEvent` | nothing |
|
|
11
9
|
|
|
10
|
+
**Package scope.** On `IgniteUI.Blazor.Lite`, register through the `api.js` module below; the `igRegisterScript` / `igRemoveScript` / `igTemplating` window globals no longer exist there. The full product (`IgniteUI.Blazor` / `IgniteUI.Blazor.Trial`, grids, charts, Dock Manager) does not ship `api.js` yet: register there through the `igRegisterScript(name, fn, shouldCall)` window global, which its `app.bundle.js` script tag installs. Its `shouldCall` defaults to `true`, so pass `false` for handlers and templates.
|
|
11
|
+
|
|
12
12
|
## Registering
|
|
13
13
|
|
|
14
14
|
```html
|
|
@@ -29,20 +29,20 @@ registerScript('OnDialogClosing', (evt) => {
|
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
- The specifier is relative to the importing script's own URL: `./_content/…` from a script at the wwwroot root, `../_content/…` from a subfolder. A classic script's `import()` resolves it against the document base.
|
|
32
|
-
- **Register at the top level of a `type="module"` script, or any time before Blazor starts.** Module scripts run once the page is parsed, while Blazor still has to fetch the component bundle before it can render, so registrations from a page-level module script are in place in time. If a registration
|
|
33
|
-
- The registered function is the script. For the few parameters that take a *value* rather than a function (e.g. `DataScript`), pass `true` as the third argument (`shouldCall`): the function is then called once when the parameter resolves and its result is used.
|
|
32
|
+
- **Register at the top level of a `type="module"` script, or any time before Blazor starts.** Module scripts run once the page is parsed, while Blazor still has to fetch the component bundle before it can render, so registrations from a page-level module script are in place in time. If a registration lands after a component rendered, the library applies it as soon as it is registered. For a hard guarantee, register from the app's own JS initializer (`beforeWebStart`).
|
|
33
|
+
- The registered function is the script. For the few parameters that take a *value* rather than a function (e.g. `DataScript`), pass `true` as the third argument (`shouldCall`): the function is then called once when the parameter resolves and its result is used.
|
|
34
34
|
- Other exports: `removeScript(name)`, and `html` — the lit-html template tag, the same instance the components render with. Typings ship at `_content/IgniteUI.Blazor/api.d.ts`.
|
|
35
35
|
- From a classic (non-module) script use a dynamic import (no top-level `await` there): `import('./_content/IgniteUI.Blazor/api.js').then(({ registerScript, html }) => { /* register */ });`
|
|
36
|
-
- The `igRegisterScript` / `igRemoveScript` / `igTemplating.html` window globals still work with the same signatures once the library has loaded, but are deprecated and warn in the console. A classic script that calls them while the page parses (before Blazor starts) needs the `<script src="_content/IgniteUI.Blazor/app.bundle.js">` tag, which queues those calls until `api.js` loads; without the tag, move the call to a module script.
|
|
37
36
|
|
|
38
37
|
## Templates
|
|
39
38
|
|
|
40
39
|
A template function receives one context object and returns an `html` template result, a string, a primitive value — anything lit can render. `html` is only needed for markup; plain text can be returned directly, and an empty string renders nothing.
|
|
41
40
|
|
|
42
|
-
The context mirrors the component's .NET template context: the same data is exposed under the same names — the item for a list item, the message for a chat message — so start from the component's C# template context type when writing one.
|
|
41
|
+
The context mirrors the component's .NET template context: the same data is exposed under the same names — the item for a list item, the message for a chat message — so start from the component's C# template context type when writing one. One exception: a Combo group header gets `{ item }`, a record holding the group's value under the `GroupKey` field, which the C# `IgbComboGroupHeaderContext` of `IgniteUI.Blazor.Lite` exposes as `Key`.
|
|
43
42
|
|
|
44
43
|
```razor
|
|
45
|
-
|
|
44
|
+
@* Full product: T="string" in place of TValue and TItem *@
|
|
45
|
+
<IgbCombo TValue="string" TItem="City" Data="Cities" ValueKey="Id" DisplayKey="Name" GroupKey="Country"
|
|
46
46
|
ItemTemplateScript="CityItem" GroupHeaderTemplateScript="CountryHeader" />
|
|
47
47
|
```
|
|
48
48
|
|
|
@@ -100,7 +100,7 @@ The parameter is **`IconName`**, not `Name` (`Name` is the framework element ide
|
|
|
100
100
|
}
|
|
101
101
|
```
|
|
102
102
|
|
|
103
|
-
`AvatarShape`: `Circle | Rounded | Square` — use `Shape`, there is no `RoundShape`. `StyleVariant` (shared by badge and chip): `Primary | Info | Success | Warning | Danger
|
|
103
|
+
`AvatarShape`: `Circle | Rounded | Square` — use `Shape`, there is no `RoundShape`. `StyleVariant` (shared by badge and chip): `Primary | Info | Success | Warning | Danger`; a chip without `Variant` has no color variant. `IgbChip` also has `Outlined`, `Selected` / `SelectedChanged` and a `Select` event.
|
|
104
104
|
|
|
105
105
|
## Progress
|
|
106
106
|
|
|
@@ -150,7 +150,7 @@ The trigger goes in `slot="target"`. `IgbDropdownGroup` groups items; `Placement
|
|
|
150
150
|
LogoSrc="images/logo.svg" LogoSize="0.6" />
|
|
151
151
|
```
|
|
152
152
|
|
|
153
|
-
Renders the `Value` string (URL, text, any payload) as a scannable SVG. `Version` (1-40) is chosen automatically when unset; `ErrorLevel` (`Low | Medium | Quartile | High`)
|
|
153
|
+
Renders the `Value` string (URL, text, any payload) as a scannable SVG. `Version` (1-40) is chosen automatically when unset; `ErrorLevel` (`Low | Medium | Quartile | High`) is `null` by default, which leaves the web component's default level, and should be raised explicitly when a larger logo needs more error correction. `Size` is the rendered pixel size and `Margin` the quiet zone in modules; `LogoSrc`, `LogoSize` and `LogoMargin` place a centered logo. Color it with the `--ig-qr-code-background`, `--ig-qr-code-dark-color`, `--ig-qr-code-corner-square-color` and `--ig-qr-code-corner-dot-color` custom properties.
|
|
154
154
|
|
|
155
155
|
`ToImageAsync(IgbQrCodeExportOptions)` exports the code as an image file (`Format`: `Svg | Png | Jpeg | Webp`, default `Png`; `Scale` multiplies `Size`; `FileName` defaults to `qr-code`). The exported file stays on the client and is always handed to the user through the browser save dialog — there is no way to read the file bytes back into .NET. The export fails when the component has no `Value`.
|
|
156
156
|
|
|
@@ -4,6 +4,17 @@ Module for every component below is `Igb<Name>Module` (`IgbInputModule`, `IgbCom
|
|
|
4
4
|
|
|
5
5
|
Verify exact members with `get_api_reference` / `get_doc` when the MCP server is available — the tables here list the members these controls are normally driven by, not their full API.
|
|
6
6
|
|
|
7
|
+
The examples compile in both packages, and the types shown are the full `IgniteUI.Blazor`'s. In `IgniteUI.Blazor.Lite`, Calendar, Color Picker, Date Picker, Date Range Picker, Date Time Input, Radio Group, Rating, Select and Slider are generic over `TValue`, the type of their value; each section lists the types it takes. Razor infers `TValue` from `@bind-Value` or `Value`, but not through a method group, so set it when there is no value, or when a method handles an event that carries the value. Those events carry generic args, such as `IgbNumberEventArgs<TValue>`:
|
|
8
|
+
|
|
9
|
+
```razor
|
|
10
|
+
<IgbSlider TValue="double" @bind-Value="Volume" Change="OnVolumeChange" />
|
|
11
|
+
|
|
12
|
+
@code {
|
|
13
|
+
double Volume { get; set; } = 40;
|
|
14
|
+
void OnVolumeChange(IgbNumberEventArgs<double> e) => Console.WriteLine(e.Detail);
|
|
15
|
+
}
|
|
16
|
+
```
|
|
17
|
+
|
|
7
18
|
## Text inputs
|
|
8
19
|
|
|
9
20
|
`IgbInput` and `IgbTextarea` share a base: `Label`, `Placeholder`, `Outlined`, `Disabled`, `Required`, `Invalid`, plus `Value` / `ValueChanged`.
|
|
@@ -40,27 +51,38 @@ Icons in `prefix` / `suffix` slots must be `IgbIcon`. A `<span class="material-i
|
|
|
40
51
|
## Combo Box
|
|
41
52
|
|
|
42
53
|
```razor
|
|
43
|
-
<IgbCombo
|
|
54
|
+
<IgbCombo Data="Cities" ValueKey="Id" DisplayKey="Name" @bind-Value="SelectedCityIds"
|
|
44
55
|
Label="Select Cities" Placeholder="Pick a city" />
|
|
45
56
|
|
|
46
57
|
@code {
|
|
47
58
|
private List<City> Cities = SampleData.Cities;
|
|
59
|
+
private string[] SelectedCityIds = [];
|
|
48
60
|
record City(string Id, string Name, string Country);
|
|
49
61
|
}
|
|
50
62
|
```
|
|
51
63
|
|
|
52
|
-
The generic
|
|
64
|
+
The combo is generic over its value type: the `ValueKey` property's type (here `City.Id`, `string`), or the item type when there is no `ValueKey`. `Value` is an array of it, even with `SingleSelect`. The full `IgniteUI.Blazor` names it `T`; `IgniteUI.Blazor.Lite` names it `TValue` and adds `TItem`, the item type `Data` takes. Razor infers them from `@bind-Value` and `Data`, so the example sets neither. Set them when there is nothing to infer them from, and in Lite whenever the combo has a `Change` handler, as its args are `IgbComboChangeEventArgs<TValue, TItem>`: `<IgbCombo T="string" …>` in the full product, `<IgbCombo TValue="string" TItem="City" …>` in Lite. `IgbCombo` does not participate in a plain HTML `<form>`; bind its value explicitly.
|
|
53
65
|
|
|
54
66
|
## Select
|
|
55
67
|
|
|
56
68
|
```razor
|
|
57
|
-
<IgbSelect @bind-Value="
|
|
58
|
-
|
|
59
|
-
|
|
69
|
+
<IgbSelect @bind-Value="CountryCode" Label="Country" Placeholder="Choose a country">
|
|
70
|
+
@foreach (var country in Countries)
|
|
71
|
+
{
|
|
72
|
+
<IgbSelectItem Value="@country.Code">@country.Name</IgbSelectItem>
|
|
73
|
+
}
|
|
60
74
|
</IgbSelect>
|
|
75
|
+
|
|
76
|
+
@code {
|
|
77
|
+
string? CountryCode { get; set; }
|
|
78
|
+
private List<Country> Countries = SampleData.Countries;
|
|
79
|
+
record Country(string Code, string Name);
|
|
80
|
+
}
|
|
61
81
|
```
|
|
62
82
|
|
|
63
|
-
`Value`
|
|
83
|
+
Write item values as C# expressions, `Value="@country.Code"` or `Value="@("us")"`, which works in both packages. Use `Placeholder` for the empty state rather than an empty item. `IgbSelectHeader` and `IgbSelectGroup` add section headings and grouping.
|
|
84
|
+
|
|
85
|
+
In `IgniteUI.Blazor.Lite`, `IgbSelect<TValue>` is generic: it takes `string`, `char`, an enum, or a numeric type, each optionally nullable. Each item infers its own `TValue` from its `Value`, so item values must have the select's exact type: an `int?` select needs `int?` values, not `int`. A bare `Value="apple"` is a C# expression there, reads as the identifier `apple`, and does not compile. `Change` carries `IgbSelectItemComponentEventArgs<TValue>`, whose `Detail` is the selected `IgbSelectItem<TValue>`. In the full product `Value` is a `string`.
|
|
64
86
|
|
|
65
87
|
## Date and time
|
|
66
88
|
|
|
@@ -80,13 +102,17 @@ The generic parameter is **`T`**, not `TValue` — set it to the data item type.
|
|
|
80
102
|
<IgbDateTimeInput @bind-Value="SelectedDateTime" InputFormat="MM/dd/yyyy HH:mm" SpinLoop="true" />
|
|
81
103
|
|
|
82
104
|
@code {
|
|
83
|
-
DateTime? SelectedDate { get; set; }
|
|
84
|
-
DateTime
|
|
105
|
+
DateTime? SelectedDate { get; set; }
|
|
106
|
+
DateTime? MinDate { get; set; } = DateTime.Today;
|
|
107
|
+
DateTime? MaxDate { get; set; } = DateTime.Today.AddYears(1);
|
|
108
|
+
DateTime CalendarValue { get; set; } = DateTime.Today;
|
|
85
109
|
DateTime? SelectedDateTime { get; set; } = DateTime.Now;
|
|
86
110
|
}
|
|
87
111
|
```
|
|
88
112
|
|
|
89
|
-
`IgbCalendar.Value` is a non-nullable `DateTime
|
|
113
|
+
In the full product `IgbCalendar.Value` is a non-nullable `DateTime` and the pickers are nullable. Multi and range calendar selection come from `Selection` (`CalendarSelection.Single | Multiple | Range`).
|
|
114
|
+
|
|
115
|
+
In `IgniteUI.Blazor.Lite`, `IgbDatePicker<TValue>`, `IgbDateRangePicker<TValue>`, `IgbCalendar<TValue>` and `IgbDateTimeInput<TValue>` take `DateTime`, `DateTime?`, or `string`, the Date Range Picker's `Value` being an `IgbDateRangeValue<TValue>`; `Min`, `Max` and `ActiveDate` take the same `TValue`, and the Calendar's `Values` is a `TValue[]`. Dates reported back are UTC (`Kind = Utc`), and `string` values come back in round-trip `"o"` form (e.g. `2026-01-02T03:04:05.0000000Z`). A cleared `DateTime?` or `string` is `null`; a cleared `DateTime` is `DateTime.MinValue`.
|
|
90
116
|
|
|
91
117
|
## Checkbox, Switch, Radio
|
|
92
118
|
|
|
@@ -97,18 +123,27 @@ The generic parameter is **`T`**, not `TValue` — set it to the data item type.
|
|
|
97
123
|
<IgbSwitch @bind-Checked="IsDarkMode">Dark Mode</IgbSwitch>
|
|
98
124
|
|
|
99
125
|
<IgbRadioGroup @bind-Value="Plan" Alignment="ContentOrientation.Vertical">
|
|
100
|
-
<IgbRadio Value="basic">Basic</IgbRadio>
|
|
101
|
-
<IgbRadio Value="pro">Pro</IgbRadio>
|
|
102
|
-
<IgbRadio Value="enterprise">Enterprise</IgbRadio>
|
|
126
|
+
<IgbRadio name="plan" Value="@("basic")">Basic</IgbRadio>
|
|
127
|
+
<IgbRadio name="plan" Value="@("pro")">Pro</IgbRadio>
|
|
128
|
+
<IgbRadio name="plan" Value="@("enterprise")">Enterprise</IgbRadio>
|
|
103
129
|
</IgbRadioGroup>
|
|
104
130
|
```
|
|
105
131
|
|
|
106
|
-
|
|
132
|
+
The selected option is the group's `Value`; radio values are written as for `IgbSelectItem`. The radios are only mutually exclusive when they share a `name`: give every radio in a group the same lowercase `name`, unique to that group, or an unbound group lets each radio stay checked. In the full product, do **not** set `Name` to group them — `Name` is the framework's element identity, not the HTML radio name.
|
|
133
|
+
|
|
134
|
+
In `IgniteUI.Blazor.Lite`, `IgbRadioGroup<TValue>` is generic: it takes `string`, `char`, `bool`, an enum, or a numeric type, each optionally nullable; each radio infers `TValue` from its own `Value`, which must have the group's type, and `Change` carries `IgbRadioChangeEventArgs<TValue>`. `Name` on `IgbRadioGroup` passes the name to each of its radios. An enum binds its members directly:
|
|
135
|
+
|
|
136
|
+
```razor
|
|
137
|
+
<IgbRadioGroup Name="tier" @bind-Value="Tier">
|
|
138
|
+
<IgbRadio Value="PlanTier.Basic">Basic</IgbRadio>
|
|
139
|
+
<IgbRadio Value="PlanTier.Pro">Pro</IgbRadio>
|
|
140
|
+
</IgbRadioGroup>
|
|
141
|
+
```
|
|
107
142
|
|
|
108
143
|
## Slider, Range Slider, Rating
|
|
109
144
|
|
|
110
145
|
```razor
|
|
111
|
-
<IgbSlider @bind-Value="Volume" Min="0" Max="100" Step="5"
|
|
146
|
+
<IgbSlider @bind-Value="Volume" @bind-Value:after="OnVolumeChanged" Min="0" Max="100" Step="5" />
|
|
112
147
|
<IgbRangeSlider Lower="20" Upper="70" Min="0" Max="100" Change="OnRangeChange" />
|
|
113
148
|
<IgbRating @bind-Value="StarRating" Max="5" AllowReset="true" />
|
|
114
149
|
|
|
@@ -116,13 +151,13 @@ Radios are grouped by being children of `IgbRadioGroup`, and the selected option
|
|
|
116
151
|
double Volume { get; set; } = 40;
|
|
117
152
|
double StarRating { get; set; } = 3;
|
|
118
153
|
|
|
119
|
-
void
|
|
154
|
+
void OnVolumeChanged() => Console.WriteLine(Volume);
|
|
120
155
|
void OnRangeChange(IgbRangeSliderValueEventArgs e)
|
|
121
156
|
=> Console.WriteLine($"{e.Detail.Lower}-{e.Detail.Upper}");
|
|
122
157
|
}
|
|
123
158
|
```
|
|
124
159
|
|
|
125
|
-
`Min`, `Max`, `Step`, `LowerBound`, `UpperBound`, `PrimaryTicks`, `SecondaryTicks`, `DiscreteTrack` and the label/tooltip options come from the shared slider base and apply to both sliders. `IgbRangeSlider` uses `Lower` / `Upper` instead of `Value`. `IgbRating.Value` and `IgbSlider.Value` are `double
|
|
160
|
+
`Min`, `Max`, `Step`, `LowerBound`, `UpperBound`, `PrimaryTicks`, `SecondaryTicks`, `DiscreteTrack` and the label/tooltip options come from the shared slider base and apply to both sliders. `IgbRangeSlider` uses `Lower` / `Upper` instead of `Value`. `@bind-Value:after` reacts to a new value without naming the event args, which differ by package: in the full product `IgbRating.Value` and `IgbSlider.Value` are `double` and their events carry `IgbNumberEventArgs`; in `IgniteUI.Blazor.Lite`, `IgbSlider<TValue>` and `IgbRating<TValue>` take `int`, `long`, `short`, `float`, `double`, or `decimal`, and the slider's `Input` / `Change` and the rating's `Change` / `Hover` carry `IgbNumberEventArgs<TValue>`.
|
|
126
161
|
|
|
127
162
|
## Color Picker
|
|
128
163
|
|
|
@@ -144,14 +179,26 @@ An HSV canvas with hue and alpha sliders, an editable color string, preset swatc
|
|
|
144
179
|
|
|
145
180
|
`Input` fires on every color change while `Change` fires on commit and drives `@bind-Value`; `Opening` / `Opened` / `Closing` / `Closed` track the picker surface. `Required`, `Disabled`, `Invalid` plus `CheckValidityAsync()` / `ReportValidityAsync()` / `SetCustomValidityAsync(message)` behave as on the other form controls.
|
|
146
181
|
|
|
182
|
+
In `IgniteUI.Blazor.Lite`, `IgbColorPicker<TValue>` takes `string` as well as `System.Drawing.Color`, either nullable, so a `Color?` property binds directly:
|
|
183
|
+
|
|
184
|
+
```razor
|
|
185
|
+
<IgbColorPicker @bind-Value="Highlight" Label="Highlight" />
|
|
186
|
+
|
|
187
|
+
@code {
|
|
188
|
+
System.Drawing.Color? Highlight { get; set; }
|
|
189
|
+
}
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
A cleared `string` picker reports `""`; as a `Color`, `null` or `Color.Empty` clears it and a cleared picker reports the same, and in `Hsl` format the color is rounded to whole-number hue, saturation and lightness. `Input` and `Change` carry `IgbColorPickerValueEventArgs<TValue>`, whose `Detail` is the color as `TValue`.
|
|
193
|
+
|
|
147
194
|
## Binding and validation
|
|
148
195
|
|
|
149
196
|
```razor
|
|
150
197
|
<IgbInput @bind-Value="Model.Name" Label="Name" Required="true" Invalid="@(!IsNameValid)" />
|
|
151
198
|
<IgbCheckbox @bind-Checked="Model.Agreed">I agree to the terms</IgbCheckbox>
|
|
152
199
|
<IgbSelect @bind-Value="Model.Country" Label="Country">
|
|
153
|
-
<IgbSelectItem Value="us">United States</IgbSelectItem>
|
|
154
|
-
<IgbSelectItem Value="uk">United Kingdom</IgbSelectItem>
|
|
200
|
+
<IgbSelectItem Value="@("us")">United States</IgbSelectItem>
|
|
201
|
+
<IgbSelectItem Value="@("uk")">United Kingdom</IgbSelectItem>
|
|
155
202
|
</IgbSelect>
|
|
156
203
|
```
|
|
157
204
|
|
|
@@ -79,7 +79,7 @@ For `IgniteUI.Blazor.Lite` the theme stylesheet is the only required tag — wit
|
|
|
79
79
|
<script src="_framework/blazor.web.js"></script>
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
On the full product, **never wrap that tag in `@Assets[...]`** — fingerprinting it breaks loading and the app renders blank ([#233](https://github.com/IgniteUI/igniteui-blazor/issues/233)).
|
|
82
|
+
On the full product, **never wrap that tag in `@Assets[...]`** — fingerprinting it breaks loading and the app renders blank ([#233](https://github.com/IgniteUI/igniteui-blazor/issues/233)). `IgniteUI.Blazor.Lite` no longer ships `app.bundle.js`; remove any existing tag, which would otherwise return 404.
|
|
83
83
|
|
|
84
84
|
Theme files under `_content/IgniteUI.Blazor/themes/` are `{light|dark}/{bootstrap|material|fluent|indigo}.css` — link exactly one.
|
|
85
85
|
|
|
@@ -92,7 +92,7 @@ Theme files under `_content/IgniteUI.Blazor/themes/` are `{light|dark}/{bootstra
|
|
|
92
92
|
`IgniteUI.Blazor.GridLite` ships its own stylesheet from its own asset root, but should be used only if you are using the GridLite component exclusively. If you are using other Ignite UI components, do not link (or suggest) the GridLite stylesheet — use the main theme stylesheet above instead.
|
|
93
93
|
|
|
94
94
|
```html
|
|
95
|
-
<link href="_content/IgniteUI.Blazor.GridLite/
|
|
95
|
+
<link href="_content/IgniteUI.Blazor.GridLite/themes/light/bootstrap.css" rel="stylesheet" />
|
|
96
96
|
```
|
|
97
97
|
|
|
98
98
|
## 5. Render mode (Blazor Web App only)
|
|
@@ -57,17 +57,17 @@ Only pick a grid when the content is genuinely tabular. A list of records with r
|
|
|
57
57
|
| Text field, search box, inline editor | `IgbInput` | `Label`, `Placeholder`, `Outlined`, `@bind-Value` |
|
|
58
58
|
| Multi-line text | `IgbTextarea` | `Rows`, `Resize` |
|
|
59
59
|
| Dropdown selecting a value | `IgbSelect` + `IgbSelectItem` | |
|
|
60
|
-
| Searchable / multi-select picker | `IgbCombo` | generic
|
|
60
|
+
| Searchable / multi-select picker | `IgbCombo` | generic over the value type: `TValue` and `TItem` in Lite, `T` in the full product; `Data`, `DisplayKey`, `ValueKey` |
|
|
61
61
|
| Contextual action menu | `IgbDropdown` | trigger in `slot="target"` — not for form values |
|
|
62
|
-
| Date picker | `IgbDatePicker`
|
|
62
|
+
| Date picker | `IgbDatePicker` | `DateTime?` in the full product; Lite: `<TValue>` is `DateTime`, `DateTime?` or `string` |
|
|
63
63
|
| Date range | `IgbDateRangePicker` | |
|
|
64
|
-
| Always-visible calendar | `IgbCalendar`
|
|
64
|
+
| Always-visible calendar | `IgbCalendar` | `Selection`, `VisibleMonths`; non-nullable `DateTime` in the full product, Lite takes `<TValue>` as the date picker does |
|
|
65
65
|
| Masked entry (phone, postal) | `IgbMaskInput` | `Mask`: `0` digit, `L` letter, `A` alphanumeric |
|
|
66
66
|
| Checkbox / switch | `IgbCheckbox` / `IgbSwitch` | `@bind-Checked` |
|
|
67
|
-
| Radio options | `IgbRadioGroup` + `IgbRadio` | `@bind-Value` on the **group**; do not use `Name` to group |
|
|
67
|
+
| Radio options | `IgbRadioGroup` + `IgbRadio` | `@bind-Value` on the **group**; do not use `Name` to group in the full product (give its radios the same lowercase `name`) |
|
|
68
68
|
| Slider / range slider | `IgbSlider` / `IgbRangeSlider` | range uses `Lower` / `Upper` |
|
|
69
69
|
| Star rating | `IgbRating` | |
|
|
70
|
-
| Color picker / color swatch input | `IgbColorPicker` | `@bind-Value` (CSS color string), `Mode` (`Default` trigger / `Input` field), `Format`, `ShowAlpha`, `Swatches` |
|
|
70
|
+
| Color picker / color swatch input | `IgbColorPicker` | `@bind-Value` (CSS color string; Lite also `System.Drawing.Color`), `Mode` (`Default` trigger / `Input` field), `Format`, `ShowAlpha`, `Swatches` |
|
|
71
71
|
| Primary action button | `IgbButton` | `Variant`: `Contained`/`Outlined`/`Flat`/`Fab` |
|
|
72
72
|
| Segmented / toggle control | `IgbButtonGroup` + `IgbToggleButton` | |
|
|
73
73
|
| Icon-only button | `IgbIconButton` | |
|