feat(api): disable attribute by passing null

ionic-team · Oct 7, 2019 · 3ac02f3 · 3ac02f3
1 parent 22eb531
commit 3ac02f3
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/src/compiler/transformers/decorators-to-static/prop-decorator.ts b/src/compiler/transformers/decorators-to-static/prop-decorator.ts
@@ -1,5 +1,5 @@
 import * as d from '../../../declarations';
-import { augmentDiagnosticWithNode, buildError, catchError, toDashCase } from '@utils';
+import { augmentDiagnosticWithNode, buildError, buildWarn, catchError, toDashCase } from '@utils';
 import { convertValueToLiteral, createStaticGetter, getAttributeTypeInfo, isMemberPrivate, resolveType, serializeSymbol, typeToString, validateReferences } from '../transform-utils';
 import { isDecoratorNamed } from './decorator-utils';
 import { validatePublicName } from '../reserved-public-members';
@@ -94,7 +94,11 @@ const parsePropDecorator = (config: d.Config, diagnostics: d.Diagnostic[], typeC
   return staticProp;
 };
 
-const getAttributeName = (_diagnostics: d.Diagnostic[], propName: string, propOptions: d.PropOptions) => {
+const getAttributeName = (diagnostics: d.Diagnostic[], propName: string, propOptions: d.PropOptions) => {
+  if (propOptions.attribute === null) {
+    return  undefined;
+  }
+
   if (typeof propOptions.attribute === 'string' && propOptions.attribute.trim().length > 0) {
     return propOptions.attribute.trim().toLowerCase();
   }

diff --git a/src/declarations/decorators.ts b/src/declarations/decorators.ts
@@ -68,7 +68,7 @@ export interface PropOptions {
    * Stencil uses different heuristics to determine the default name of the attribute,
    * but using this property, you can override the default behaviour.
    */
-  attribute?: string;
+  attribute?: string | null;
 
   /**
    * A Prop is _by default_ immutable from inside the component logic.