@seeqdev/qomponents 0.0.69 → 0.0.71

package/dist/example/src/ComplexSelectExample.tsx

@@ -1,81 +1,81 @@
-import React from 'react';
-import { Icon, Select } from '@seeqdev/qomponents';
-
-export interface SelectOption {
-  id: string;
-  label: string;
-  color: string;
-  asset: string;
-  type: 'SCALAR' | 'STRING' | 'NUMERIC';
-}
-
-const options: SelectOption[] = [
-  { id: '1', label: 'Label for the first entry', color: 'pink', asset: 'Asset 1', type: 'NUMERIC' },
-  { id: '2', label: 'Label for the second entry', color: 'green', asset: 'Asset 2', type: 'SCALAR' },
-  { id: '3', label: 'Label for the third entry', color: 'orange', asset: 'Asset 3', type: 'STRING' },
-];
-
-interface ComplexSelectExampleProps {
-  onChange: (selectedOption: SelectOption) => void;
-  value: SelectOption | undefined;
-}
-
-function ComplexSelectExample({ onChange, value }: ComplexSelectExampleProps) {
-  const getIcon = (type: string) => {
-    switch (type) {
-      case 'STRING':
-        return 'fa fa-font';
-      case 'SCALAR':
-        return 'fc-scalar';
-      default:
-        return 'fc-series';
-    }
-  };
-  /**
-   * This function formats the select option as desired. You can apply css styling here or use additional qomponents
-   * to style the select option display.
-   *
-   * You can use the same function to format the selected value or use a different one (sometimes having a separate
-   * function is helpful if you want to limit the space that is taken up by the selected option).
-   *
-   * This example shows how to use an additional Icon component (styled in color based on the select option) as well
-   * as how to display the properties of the select option
-   */
-  const getOptionLabel = (optionValue: SelectOption): React.ReactNode => {
-    return (
-      <div className="selectOptionWrapperDiv">
-        <Icon icon={getIcon(optionValue.type)} type="color" color={optionValue.color} extraClassNames="mr-10" />
-        <div className="selectOptionDiv">
-          <div className="selectOption">
-            <strong>{optionValue.label}</strong>
-          </div>
-          <div className="selectOptionSubText">{optionValue.asset}</div>
-        </div>
-      </div>
-    );
-  };
-  const getOptionValue = (option: SelectOption) => {
-    return option.id;
-  };
-
-  return (
-    // use the getOptionLabel function to provide a custom render function that determines how the select options
-    // are displayed
-    // use the getSelectedValueLabel function to provide a custom render function that determines how the selected
-    // option is displayed
-    <Select
-      placeholder="formatted select options"
-      extraClassNames="formElementWidth"
-      options={options}
-      value={value}
-      getOptionLabel={getOptionLabel}
-      getOptionValue={getOptionValue}
-      getSelectedValueLabel={getOptionLabel}
-      onChange={(selectedOption: SelectOption) => {
-        onChange(selectedOption);
-      }}
-    />
-  );
-}
-
-export default ComplexSelectExample;
+import React from 'react';
+import { Icon, Select } from '@seeqdev/qomponents';
+
+export interface SelectOption {
+  id: string;
+  label: string;
+  color: string;
+  asset: string;
+  type: 'SCALAR' | 'STRING' | 'NUMERIC';
+}
+
+const options: SelectOption[] = [
+  { id: '1', label: 'Label for the first entry', color: 'pink', asset: 'Asset 1', type: 'NUMERIC' },
+  { id: '2', label: 'Label for the second entry', color: 'green', asset: 'Asset 2', type: 'SCALAR' },
+  { id: '3', label: 'Label for the third entry', color: 'orange', asset: 'Asset 3', type: 'STRING' },
+];
+
+interface ComplexSelectExampleProps {
+  onChange: (selectedOption: SelectOption) => void;
+  value: SelectOption | undefined;
+}
+
+function ComplexSelectExample({ onChange, value }: ComplexSelectExampleProps) {
+  const getIcon = (type: string) => {
+    switch (type) {
+      case 'STRING':
+        return 'fa fa-font';
+      case 'SCALAR':
+        return 'fc-scalar';
+      default:
+        return 'fc-series';
+    }
+  };
+  /**
+   * This function formats the select option as desired. You can apply css styling here or use additional qomponents
+   * to style the select option display.
+   *
+   * You can use the same function to format the selected value or use a different one (sometimes having a separate
+   * function is helpful if you want to limit the space that is taken up by the selected option).
+   *
+   * This example shows how to use an additional Icon component (styled in color based on the select option) as well
+   * as how to display the properties of the select option
+   */
+  const getOptionLabel = (optionValue: SelectOption): React.ReactNode => {
+    return (
+      <div className="selectOptionWrapperDiv">
+        <Icon icon={getIcon(optionValue.type)} type="color" color={optionValue.color} extraClassNames="mr-10" />
+        <div className="selectOptionDiv">
+          <div className="selectOption">
+            <strong>{optionValue.label}</strong>
+          </div>
+          <div className="selectOptionSubText">{optionValue.asset}</div>
+        </div>
+      </div>
+    );
+  };
+  const getOptionValue = (option: SelectOption) => {
+    return option.id;
+  };
+
+  return (
+    // use the getOptionLabel function to provide a custom render function that determines how the select options
+    // are displayed
+    // use the getSelectedValueLabel function to provide a custom render function that determines how the selected
+    // option is displayed
+    <Select
+      placeholder="formatted select options"
+      extraClassNames="formElementWidth"
+      options={options}
+      value={value}
+      getOptionLabel={getOptionLabel}
+      getOptionValue={getOptionValue}
+      getSelectedValueLabel={getOptionLabel}
+      onChange={(selectedOption: SelectOption) => {
+        onChange(selectedOption);
+      }}
+    />
+  );
+}
+
+export default ComplexSelectExample;

package/dist/example/src/Example.tsx

@@ -1,167 +1,167 @@
-import React from 'react';
-import { Button, Checkbox, Icon, QTip, Select, TextArea, TextField } from '@seeqdev/qomponents';
-import ComplexSelectExample, { SelectOption } from './ComplexSelectExample';
-
-const availableThemes = [
-  { display: 'Analysis', value: 'color_analysis' },
-  { display: 'Topic', value: 'color_topic' },
-  { display: 'DataLab', value: 'color_datalab' },
-];
-
-const options = [
-  { value: '1', label: 'Beginner' },
-  { value: '2', label: 'Advanced' },
-  { value: '3', label: 'Expert' },
-];
-
-function Example() {
-  /**
-   * Theming is supported "out of the box". To apply a theme wrap your addOn in a div and assign the class that
-   * matched the desired theme:
-   * - color_analysis for Analysis styled qomponents (green)
-   * - color_topic for Topic styled qomponents (blue)
-   * - DataLab for DataLab styled qomponents (orange)
-   */
-  const [theme, setTheme] = React.useState('color_analysis');
-  /**
-   * qomponents also support dark-mode. To render qomponents using dark-mode wrap your addOn in a div and assign the
-   * class "tw-dark" for dark-mode or "tw-light" for light mode.
-   */
-  const [mode, setMode] = React.useState('tw-light');
-
-  /**
-   * This example uses controlled inputs (https://blog.logrocket.com/controlled-vs-uncontrolled-components-in-react/)
-   */
-  const [textFieldValue, setTextFieldValue] = React.useState('');
-  const [textAreaValue, setTextAreaValue] = React.useState('');
-  const [selectValue, setSelectValue] = React.useState();
-  const [complexSelectedValue, setComplexSelectedValue] = React.useState<SelectOption>();
-  const [display, setDisplay] = React.useState('');
-  const [easeOfUse, setEaseOfUse] = React.useState(false);
-  const [lookAndFeel, setLookAndFeel] = React.useState(false);
-  const [speed, setSpeed] = React.useState(false);
-
-  return (
-    // outer-wrapper div that assigns the mode (dark-mode or light) as well as the theme
-    <div className={`backdrop ${mode} ${theme}`}>
-      {/*add the QTip component at the very top level or your application to ensure your tooltips display as expected!*/}
-      <QTip />
-      <div className="flex-container">
-        <div className="scroll-container">
-          <div className="header">qomponents - form example</div>
-          <div>Use this example to see qomponents in actions.</div>
-          No libraries other than Seeq's qomponents (and of course React) are used to create this example, however
-          minimal CSS is used to create an appealing form - you can find all that CSS in index.css.
-          <p className="mb-10">
-            <b>A note on CSS:</b> Seeq's qomponents come fully styled and ready to use. While it is tempting to use the
-            available <i>extraClassNames</i> property to provide yet additional styling we strongly advise you to use
-            this property to provide only width, margins and padding. This will ensure for a smooth upgrade experience
-            when Seeq's look and feel changes. <br />
-            Tip: to indicate missing or wrong user input use the <i>showError</i> property available on TextField,
-            TextArea, as well as Select.
-          </p>
-          <p className="mb-10">
-            Using FontAwesome? You can pass FontAwesome Icons to the qomponent Icon component
-            <Icon icon="fa-regular fa-face-smile" extraClassNames="ml-10" />
-          </p>
-          <div className="mb-10">
-            <a
-              href="#"
-              onClick={() => setMode(mode === 'tw-light' ? 'tw-dark' : 'tw-light')}
-              // this is how you display a q-tip for an element that doesn't come with an "out-of the box" tooltip
-              // property:
-              data-qtip-text="Toggle Dark/Light Mode."
-              // the position is optional and defaults to top
-              data-qtip-position="bottom">
-              <Icon icon="fc-sun" extraClassNames="mr-10" />
-              Click to toggle to {mode === 'tw-light' ? 'Dark Mode' : 'Light Mode'}
-            </a>
-          </div>
-          <div className="formRow">
-            <div className="labelWidth">Select theme:</div>
-            {availableThemes.map((t) => (
-              <Checkbox
-                type="radio"
-                checked={theme === t.value}
-                value={t.value}
-                label={t.display}
-                onChange={(e) => setTheme(e.target.value)}
-                extraClassNames="mr-10"
-              />
-            ))}
-          </div>
-          <div className="formRow">
-            <div className="labelWidth">AddOn Name</div>
-            <TextField
-              placeholder="you must enter a name"
-              extraClassNames="formElementWidth"
-              value={textFieldValue}
-              showError={textFieldValue === ''}
-              onChange={(e: React.ChangeEvent<HTMLInputElement>) => setTextFieldValue(e.target.value)}
-            />
-          </div>
-          <div className="formRow">
-            <div className="labelWidth">Description</div>
-            <TextArea
-              value={textAreaValue}
-              onChange={(e: React.ChangeEvent<HTMLInputElement>) => setTextAreaValue(e.target.value)}
-              extraClassNames="formElementWidth"
-              placeholder="provide some text here"
-            />
-          </div>
-          <div className="formRow">
-            <div className="labelWidth">Goals</div>
-            <div className="formColumn">
-              <div>
-                <Checkbox checked={easeOfUse} label="Ease of Use" onChange={() => setEaseOfUse(!easeOfUse)} />
-                <Checkbox
-                  checked={lookAndFeel}
-                  label="Improved Look & Feel"
-                  onChange={() => setLookAndFeel(!lookAndFeel)}
-                />
-                <Checkbox checked={speed} label="Speedy Development" onChange={() => setSpeed(!speed)} />
-              </div>
-            </div>
-          </div>
-          <div className="formRow">
-            <div className="labelWidth">Level</div>
-            <Select
-              value={selectValue}
-              extraClassNames="formElementWidth"
-              onChange={(selectValue) => setSelectValue(selectValue)}
-              options={options}
-              placeholder="please choose"
-            />
-          </div>
-          <div className="formRow">
-            <div className="labelWidth">Advanced</div>
-            <ComplexSelectExample
-              value={complexSelectedValue}
-              onChange={(selectedOption: SelectOption) => setComplexSelectedValue(selectedOption)}
-            />
-          </div>
-          <div className="buttonRow">
-            <Button
-              label="Cancel"
-              onClick={() => {
-                setDisplay('cancel');
-              }}
-              extraClassNames="mr-10"
-            />
-            <Button
-              label="Submit"
-              onClick={() => {
-                setDisplay('success');
-              }}
-              variant="theme"
-            />
-          </div>
-          {display === 'success' && <div>submit button onClick function was called</div>}
-          {display === 'cancel' && <div>cancel button onClick function was called</div>}
-        </div>
-      </div>
-    </div>
-  );
-}
-
-export default Example;
+import React from 'react';
+import { Button, Checkbox, Icon, QTip, Select, TextArea, TextField } from '@seeqdev/qomponents';
+import ComplexSelectExample, { SelectOption } from './ComplexSelectExample';
+
+const availableThemes = [
+  { display: 'Analysis', value: 'color_analysis' },
+  { display: 'Topic', value: 'color_topic' },
+  { display: 'DataLab', value: 'color_datalab' },
+];
+
+const options = [
+  { value: '1', label: 'Beginner' },
+  { value: '2', label: 'Advanced' },
+  { value: '3', label: 'Expert' },
+];
+
+function Example() {
+  /**
+   * Theming is supported "out of the box". To apply a theme wrap your addOn in a div and assign the class that
+   * matched the desired theme:
+   * - color_analysis for Analysis styled qomponents (green)
+   * - color_topic for Topic styled qomponents (blue)
+   * - DataLab for DataLab styled qomponents (orange)
+   */
+  const [theme, setTheme] = React.useState('color_analysis');
+  /**
+   * qomponents also support dark-mode. To render qomponents using dark-mode wrap your addOn in a div and assign the
+   * class "tw-dark" for dark-mode or "tw-light" for light mode.
+   */
+  const [mode, setMode] = React.useState('tw-light');
+
+  /**
+   * This example uses controlled inputs (https://blog.logrocket.com/controlled-vs-uncontrolled-components-in-react/)
+   */
+  const [textFieldValue, setTextFieldValue] = React.useState('');
+  const [textAreaValue, setTextAreaValue] = React.useState('');
+  const [selectValue, setSelectValue] = React.useState();
+  const [complexSelectedValue, setComplexSelectedValue] = React.useState<SelectOption>();
+  const [display, setDisplay] = React.useState('');
+  const [easeOfUse, setEaseOfUse] = React.useState(false);
+  const [lookAndFeel, setLookAndFeel] = React.useState(false);
+  const [speed, setSpeed] = React.useState(false);
+
+  return (
+    // outer-wrapper div that assigns the mode (dark-mode or light) as well as the theme
+    <div className={`backdrop ${mode} ${theme}`}>
+      {/*add the QTip component at the very top level or your application to ensure your tooltips display as expected!*/}
+      <QTip />
+      <div className="flex-container">
+        <div className="scroll-container">
+          <div className="header">qomponents - form example</div>
+          <div>Use this example to see qomponents in actions.</div>
+          No libraries other than Seeq's qomponents (and of course React) are used to create this example, however
+          minimal CSS is used to create an appealing form - you can find all that CSS in index.css.
+          <p className="mb-10">
+            <b>A note on CSS:</b> Seeq's qomponents come fully styled and ready to use. While it is tempting to use the
+            available <i>extraClassNames</i> property to provide yet additional styling we strongly advise you to use
+            this property to provide only width, margins and padding. This will ensure for a smooth upgrade experience
+            when Seeq's look and feel changes. <br />
+            Tip: to indicate missing or wrong user input use the <i>showError</i> property available on TextField,
+            TextArea, as well as Select.
+          </p>
+          <p className="mb-10">
+            Using FontAwesome? You can pass FontAwesome Icons to the qomponent Icon component
+            <Icon icon="fa-regular fa-face-smile" extraClassNames="ml-10" />
+          </p>
+          <div className="mb-10">
+            <a
+              href="#"
+              onClick={() => setMode(mode === 'tw-light' ? 'tw-dark' : 'tw-light')}
+              // this is how you display a q-tip for an element that doesn't come with an "out-of the box" tooltip
+              // property:
+              data-qtip-text="Toggle Dark/Light Mode."
+              // the position is optional and defaults to top
+              data-qtip-position="bottom">
+              <Icon icon="fc-sun" extraClassNames="mr-10" />
+              Click to toggle to {mode === 'tw-light' ? 'Dark Mode' : 'Light Mode'}
+            </a>
+          </div>
+          <div className="formRow">
+            <div className="labelWidth">Select theme:</div>
+            {availableThemes.map((t) => (
+              <Checkbox
+                type="radio"
+                checked={theme === t.value}
+                value={t.value}
+                label={t.display}
+                onChange={(e) => setTheme(e.target.value)}
+                extraClassNames="mr-10"
+              />
+            ))}
+          </div>
+          <div className="formRow">
+            <div className="labelWidth">AddOn Name</div>
+            <TextField
+              placeholder="you must enter a name"
+              extraClassNames="formElementWidth"
+              value={textFieldValue}
+              showError={textFieldValue === ''}
+              onChange={(e: React.ChangeEvent<HTMLInputElement>) => setTextFieldValue(e.target.value)}
+            />
+          </div>
+          <div className="formRow">
+            <div className="labelWidth">Description</div>
+            <TextArea
+              value={textAreaValue}
+              onChange={(e: React.ChangeEvent<HTMLInputElement>) => setTextAreaValue(e.target.value)}
+              extraClassNames="formElementWidth"
+              placeholder="provide some text here"
+            />
+          </div>
+          <div className="formRow">
+            <div className="labelWidth">Goals</div>
+            <div className="formColumn">
+              <div>
+                <Checkbox checked={easeOfUse} label="Ease of Use" onChange={() => setEaseOfUse(!easeOfUse)} />
+                <Checkbox
+                  checked={lookAndFeel}
+                  label="Improved Look & Feel"
+                  onChange={() => setLookAndFeel(!lookAndFeel)}
+                />
+                <Checkbox checked={speed} label="Speedy Development" onChange={() => setSpeed(!speed)} />
+              </div>
+            </div>
+          </div>
+          <div className="formRow">
+            <div className="labelWidth">Level</div>
+            <Select
+              value={selectValue}
+              extraClassNames="formElementWidth"
+              onChange={(selectValue) => setSelectValue(selectValue)}
+              options={options}
+              placeholder="please choose"
+            />
+          </div>
+          <div className="formRow">
+            <div className="labelWidth">Advanced</div>
+            <ComplexSelectExample
+              value={complexSelectedValue}
+              onChange={(selectedOption: SelectOption) => setComplexSelectedValue(selectedOption)}
+            />
+          </div>
+          <div className="buttonRow">
+            <Button
+              label="Cancel"
+              onClick={() => {
+                setDisplay('cancel');
+              }}
+              extraClassNames="mr-10"
+            />
+            <Button
+              label="Submit"
+              onClick={() => {
+                setDisplay('success');
+              }}
+              variant="theme"
+            />
+          </div>
+          {display === 'success' && <div>submit button onClick function was called</div>}
+          {display === 'cancel' && <div>cancel button onClick function was called</div>}
+        </div>
+      </div>
+    </div>
+  );
+}
+
+export default Example;