chore(docs): Update code block language code

vendure-ecommerce · Sep 12, 2023 · 6c21cc9 · 6c21cc9
1 parent 63e7e44
commit 6c21cc9
Show file tree

Hide file tree

Showing 12 changed files with 70,875 additions and 21,630 deletions.
diff --git a/packages/admin-ui/src/lib/core/src/common/generated-types.ts b/packages/admin-ui/src/lib/core/src/common/generated-types.ts
diff --git a/packages/admin-ui/src/lib/core/src/extension/add-action-bar-item.ts b/packages/admin-ui/src/lib/core/src/extension/add-action-bar-item.ts
@@ -5,18 +5,18 @@ import { NavBuilderService } from '../providers/nav-builder/nav-builder.service'
 /**
  * @description
  * Adds a button to the ActionBar at the top right of each list or detail view. The locationId can
- * be determined by inspecting the DOM and finding the <vdr-action-bar> element and its
+ * be determined by inspecting the DOM and finding the `<vdr-action-bar>` element and its
  * `data-location-id` attribute.
  *
  * This should be used in the NgModule `providers` array of your ui extension module.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@NgModule({
  *   imports: [SharedModule],
  *   providers: [
  *     addActionBarItem({
- *      id: 'print-invoice'
+ *      id: 'print-invoice',
  *      label: 'Print Invoice',
  *      locationId: 'order-detail',
  *      routerLink: ['/extensions/invoicing'],

diff --git a/packages/admin-ui/src/lib/core/src/extension/add-nav-menu-item.ts b/packages/admin-ui/src/lib/core/src/extension/add-nav-menu-item.ts
@@ -11,7 +11,7 @@ import { NavBuilderService } from '../providers/nav-builder/nav-builder.service'
  * This should be used in the NgModule `providers` array of your ui extension module.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@NgModule({
  *   imports: [SharedModule],
  *   providers: [
@@ -51,7 +51,7 @@ export function addNavMenuSection(config: NavMenuSection, before?: string): Prov
  * This should be used in the NgModule `providers` array of your ui extension module.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@NgModule({
  *   imports: [SharedModule],
  *   providers: [

diff --git a/packages/admin-ui/src/lib/core/src/extension/register-form-input-component.ts b/packages/admin-ui/src/lib/core/src/extension/register-form-input-component.ts
@@ -9,7 +9,7 @@ import { ComponentRegistryService } from '../providers/component-registry/compon
  * a custom field.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@NgModule({
  *   imports: [SharedModule],
  *   declarations: [MyCustomFieldControl],
@@ -23,7 +23,7 @@ import { ComponentRegistryService } from '../providers/component-registry/compon
  * This input component can then be used in a custom field:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * const config = {
  *   // ...
  *   customFields: {
@@ -41,7 +41,7 @@ import { ComponentRegistryService } from '../providers/component-registry/compon
  * or with an argument of a {@link ConfigurableOperationDef}:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * args: {
  *   rrp: { type: 'int', ui: { component: 'my-custom-input' } },
  * }

diff --git a/packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts b/packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts
@@ -98,9 +98,18 @@ export interface ActionBarItem {
     label: string;
     locationId: ActionBarLocationId;
     /**
+     * @description
+     * Deprecated since v2.1.0 - use `buttonState` instead.
      * @deprecated - use `buttonState` instead.
      */
     disabled?: Observable<boolean>;
+    /**
+     * @description
+     * A function which returns an observable of the button state, allowing you to
+     * dynamically enable/disable or show/hide the button.
+     *
+     * @since 2.1.0
+     */
     buttonState?: (context: ActionBarContext) => Observable<ActionBarButtonState>;
     onClick?: (event: MouseEvent, context: ActionBarContext) => void;
     routerLink?: RouterLinkDefinition;

diff --git a/packages/asset-server-plugin/e2e/graphql/generated-e2e-asset-server-plugin-types.ts b/packages/asset-server-plugin/e2e/graphql/generated-e2e-asset-server-plugin-types.ts
@@ -3962,7 +3962,7 @@ export type PaymentStateTransitionError = ErrorResult & {
  * based on the activeUserId of the current session. As a result, the resolver code looks like this:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@Query()
  * \@Allow(Permission.Owner)
  * async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {