@ng-doc/core - npm Package Compare versions

Comparing version 16.11.1 to 16.12.0

helpers/index.d.ts

@@ -8,2 +8,3 @@ export * from './as-array';
 export * from './extract-value';
+export * from './filter-object';
 export * from './is-iterable';
@@ -10,0 +11,0 @@ export * from './is-keyboard-event';

helpers/index.js

@@ -11,2 +11,3 @@ "use strict";
 tslib_1.__exportStar(require("./extract-value"), exports);
+tslib_1.__exportStar(require("./filter-object"), exports);
 tslib_1.__exportStar(require("./is-iterable"), exports);
@@ -13,0 +14,0 @@ tslib_1.__exportStar(require("./is-keyboard-event"), exports);

interfaces/playground-config.d.ts

 import { Type } from '@angular/core';
 import { NgDocPlaygroundContent } from './playground-content';
 import { NgDocPlaygroundOptions } from './playground-options';
+/**
+ * Playground control configuration
+ */
+export interface NgDocPlaygroundControlConfig {
+    /**
+     * Input type that will be used to display the playground control (e.g. `string`, `number`, `boolean`, `MyOwnType`)
+     */
+    type: string;
+    /**
+     * Input alias that will be used to set the input value (e.g. `myInputAlias`)
+     */
+    alias?: string;
+    /**
+     * Input description that will be used to display the tooltip on the playground control
+     */
+    description?: string;
+    /**
+     * List of possible options, it can be list of Type Alias items
+     */
+    options?: string[];
+}
 /** Playground configuration */
@@ -11,2 +32,11 @@ export interface NgDocPlaygroundConfig extends NgDocPlaygroundOptions {
     /**
+     * List of playground controls that will be used to render the side panel.
+     * NgDoc will try to guess playground controls from the component inputs, but you can override them here
+     * or add new ones.
+     *
+     * Object key is the class property name, and value is a type of the control. If your input name and property name
+     * are different, you can provide `NgDocPlaygroundControlConfig` object instead of a string to specify the input alias.
+     */
+    controls?: Record<string, string | NgDocPlaygroundControlConfig>;
+    /**
      *  Dynamic content that you can provide to create content toggle button
@@ -13,0 +43,0 @@ *  The object key should be used in the playground's

interfaces/playground-data.d.ts

@@ -1,2 +0,2 @@
-/** List of playground properties, where key is't a name of the input */
+/** List of playground properties, where key is't a name of property */
 export type NgDocPlaygroundProperties = Record<string, NgDocPlaygroundProperty>;
@@ -7,3 +7,3 @@ /** Playground property data */
     type: string;
-    /** The name of the property in the code (it can be different from input name) */
+    /** The name of the input in the code (it can be different from property name) */
     inputName: string;
@@ -10,0 +10,0 @@ /** Commend for the property */

interfaces/playground-options.d.ts

@@ -30,2 +30,6 @@ /**
     /**
+     * List of inputs that will be hidden in the playground (e.g. `['myInputName']`)
+     */
+    hiddenInputs?: string[];
+    /**
      * Custom data that you can use in the templates (e.g. `{{data.providedProperty}}`)
@@ -32,0 +36,0 @@ */

package.json

 {
   "name": "@ng-doc/core",
-  "version": "16.11.1",
+  "version": "16.12.0",
   "type": "commonjs",
@@ -5,0 +5,0 @@ "sideEffects": false,

No alert changes

Improved metrics

Total package byte prevSize

57659

4.63%

Number of package files

167

1.83%

Lines of code

1055

5.18%

No dependency changes