Convert modebar attributes to TS

Author: camdecoster

src/components/modebar/attributes.js src/components/modebar/attributes.tssrc/components/modebar/attributes.js renamed to src/components/modebar/attributes.ts

@@ -1,40 +1,45 @@
 'use strict';
 
-var constants = require('./constants');
+import type { AttributeMap, AttrsToType } from '../../types/lib/attributes';
 
-module.exports = {
+const constants = require('./constants');
+
+/**
+ * @generates ModeBar
+ */
+const attributes = {
     editType: 'modebar',
 
     orientation: {
         valType: 'enumerated',
-        values: ['v', 'h'],
+        values: ['v', 'h'] as const,
         dflt: 'h',
         editType: 'modebar',
-        description: 'Sets the orientation of the modebar.'
+        description: 'Sets the orientation of the modebar.',
     },
     bgcolor: {
         valType: 'color',
         editType: 'modebar',
-        description: 'Sets the background color of the modebar.'
+        description: 'Sets the background color of the modebar.',
     },
     color: {
         valType: 'color',
         editType: 'modebar',
-        description: 'Sets the color of the icons in the modebar.'
+        description: 'Sets the color of the icons in the modebar.',
     },
     activecolor: {
         valType: 'color',
         editType: 'modebar',
-        description: 'Sets the color of the active or hovered on icons in the modebar.'
+        description: 'Sets the color of the active or hovered on icons in the modebar.',
     },
     uirevision: {
         valType: 'any',
         editType: 'none',
         description: [
             'Controls persistence of user-driven changes related to the modebar,',
             'including `hovermode`, `dragmode`, and `showspikes` at both the',
-            'root level and inside subplots. Defaults to `layout.uirevision`.'
-        ].join(' ')
+            'root level and inside subplots. Defaults to `layout.uirevision`.',
+        ].join(' '),
     },
     add: {
         valType: 'string',
@@ -46,8 +51,8 @@ module.exports = {
             'Please note that these buttons will only be shown if they are',
             'compatible with all trace types used in a graph.',
             'Similar to `config.modeBarButtonsToAdd` option.',
-            'This may include *' + constants.backButtons.join('*, *') + '*.'
-        ].join(' ')
+            'This may include *' + constants.backButtons.join('*, *') + '*.',
+        ].join(' '),
     },
     remove: {
         valType: 'string',
@@ -57,7 +62,11 @@ module.exports = {
         description: [
             'Determines which predefined modebar buttons to remove.',
             'Similar to `config.modeBarButtonsToRemove` option.',
-            'This may include *' + constants.foreButtons.join('*, *') + '*.'
-        ].join(' ')
-    }
-};
+            'This may include *' + constants.foreButtons.join('*, *') + '*.',
+        ].join(' '),
+    },
+} as const satisfies AttributeMap;
+
+export type ModeBarAttributes = AttrsToType<typeof attributes>;
+
+export default attributes;

src/components/modebar/defaults.js

@@ -3,7 +3,7 @@
 var Lib = require('../../lib');
 var Color = require('../color');
 var Template = require('../../plot_api/plot_template');
-var attributes = require('./attributes');
+var attributes = require('./attributes').default;
 
 module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
     var containerIn = layoutIn.modebar || {};

src/components/modebar/index.js

@@ -4,7 +4,7 @@ module.exports = {
     moduleType: 'component',
     name: 'modebar',
 
-    layoutAttributes: require('./attributes'),
+    layoutAttributes: require('./attributes').default,
     supplyLayoutDefaults: require('./defaults'),
 
     manage: require('./manage')