Class IgbThemeProvider

A theme provider component that uses Lit context to provide theme information to descendant components. This component allows you to scope a theme to a specific part of the page. All library components within this provider will use the specified theme instead of the global theme. @remarks When using the theme provider, it must be registered before any descendant components that will consume the theme context. This ensures the context provider is available when descendant components attempt to consume it.

import { defineComponents, IgcThemeProviderComponent, IgcButtonComponent } from 'igniteui-webcomponents';
// Register theme provider first, then descendant components
defineComponents(IgcThemeProviderComponent, IgcButtonComponent);

@example

Material Dark Button
Fluent Light Button

Inheritance

System.Object

BaseRendererControl

IgbThemeProvider

Implements

JsonSerializable

System.IDisposable

Inherited Members

BaseRendererControl.eventCallbacksCache

BaseRendererControl._cachedSerializedContent

BaseRendererControl.ResolveEventBehavior()

BaseRendererControl.ToSpinal(String)

BaseRendererControl.TransformSimpleKey(String)

BaseRendererControl.IsTransformedEnumValue(String)

BaseRendererControl.TransformPotentialEnumValue(String, Object)

BaseRendererControl.BuildSequenceInfo(Int32)

BaseRendererControl.BuildRenderTree(RenderTreeBuilder)

BaseRendererControl.TemplateContentType(String)

BaseRendererControl.OnAfterRenderAsync(Boolean)

BaseRendererControl.EnsureReady()

BaseRendererControl.MarkPropDirty(String)

BaseRendererControl.IsPropDirty(String)

BaseRendererControl.Serialize(SerializationContext, String)

BaseRendererControl.Serialize()

BaseRendererControl.InvokeMethod(String, Object[], String[], ElementReference[])

BaseRendererControl.InvokeMethodSync(String, Object[], String[], ElementReference[])

BaseRendererControl.SuspendNotifications(Object)

BaseRendererControl.ResumeNotifications(Object, Boolean)

BaseRendererControl.NotifyInsertItem(Object, Int32, Object)

BaseRendererControl.NotifyRemoveItem(Object, Int32, Object)

BaseRendererControl.NotifyClearItems(Object)

BaseRendererControl.NotifySetItem(Object, Int32, Object, Object)

BaseRendererControl.NotifyUpdateItem(Object, Int32, Object, Boolean)

BaseRendererControl.OnRefChanged(String, Object)

BaseRendererControl.OnInvokeReturn(Int64, Object)

BaseRendererControl.Camelize(String)

BaseRendererControl.ToPascal(String)

BaseRendererControl.OnElementNameChanged(BaseRendererElement, String, String)

BaseRendererControl.Dispose(Boolean)

BaseRendererControl.SetResourceStringAsync(String, String, String)

BaseRendererControl.SetResourceStringAsync(String, String)

BaseRendererControl.SetPropertyValue(Object, PropertyInfo, JsonElement)

BaseRendererControl.SetPropertyValue(Object, PropertyInfo, Object)

BaseRendererControl.CompareEventCallbacks<T>(T, T, Dictionary<Type, Dictionary<String, FieldInfo>>)

BaseRendererControl.Finalize()

BaseRendererControl.Dispose()

BaseRendererControl.IgBlazor

BaseRendererControl.Height

BaseRendererControl.Width

BaseRendererControl.Class

BaseRendererControl.AdditionalAttributes

BaseRendererControl.ParentTypeName

BaseRendererControl.EventBehavior

BaseRendererControl.ChildContent

BaseRendererControl.RoundTripDateConversion

BaseRendererControl.NeedsDynamicContent

BaseRendererControl.UseCamelEnumValues

Namespace: IgniteUI.Blazor.Controls

Assembly: IgniteUI.Blazor.dll

Syntax

public class IgbThemeProvider : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbThemeProvider()

Declaration

public IgbThemeProvider()

Properties

DefaultEventBehavior

Declaration

protected override ControlEventBehavior DefaultEventBehavior { get; }

Property Value

Type	Description
ControlEventBehavior

Overrides

BaseRendererControl.DefaultEventBehavior

DirectRenderElementName

Declaration

protected override string DirectRenderElementName { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererControl.DirectRenderElementName

SupportsVisualChildren

Declaration

protected override bool SupportsVisualChildren { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseRendererControl.SupportsVisualChildren

Theme

The theme to provide to descendant components. @default 'bootstrap'

Declaration

public Theme Theme { get; set; }

Property Value

Type	Description
Theme

Type

Declaration

public override string Type { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererControl.Type

UseDirectRender

Declaration

protected override bool UseDirectRender { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseRendererControl.UseDirectRender

Variant

The theme variant to provide to descendant components. @default 'light'

Declaration

public ThemeVariant Variant { get; set; }

Property Value

Type	Description
ThemeVariant

Methods

EnsureModulesLoaded()

Declaration

protected override void EnsureModulesLoaded()

Overrides

BaseRendererControl.EnsureModulesLoaded()

FindByName(String)

Declaration

public override object FindByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Object

Overrides

BaseRendererControl.FindByName(String)

ResolveDisplay()

Declaration

protected override string ResolveDisplay()

Returns

Type	Description
System.String

Overrides

BaseRendererControl.ResolveDisplay()

SetNativeElement(Object)

Declaration

public void SetNativeElement(object element)

Parameters

Type	Name	Description
System.Object	element

SetNativeElementAsync(Object)

Declaration

public Task SetNativeElementAsync(object element)

Parameters

Type	Name	Description
System.Object	element

Returns

Type	Description
System.Threading.Tasks.Task

Implements

JsonSerializable

System.IDisposable