Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: TUP-700 @tacc/core-components #463

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
2f710be
feat: TUP-700 @tacc/core-components - package (#433)
wesleyboar May 16, 2024
9e6af47
feat: TUP-700 @tacc/core-components - wrappers (#461)
wesleyboar May 16, 2024
a641527
feat: TUP-700 @tacc/core-components - storybook (#462)
wesleyboar May 16, 2024
def294a
fix: support .js imports
wesleyboar May 17, 2024
89052fc
chore: use index.js when component is .jsx
wesleyboar May 17, 2024
3e4f9df
fix: remove unused prop (#466)
wesleyboar May 20, 2024
df64ce7
chore: Section use index.js when component is .jsx
wesleyboar May 21, 2024
41116e6
feat: TUP-700 @tacc/core-components - publish (#464)
wesleyboar May 21, 2024
5c0f4d9
docs: TUP-700 @tacc/core-components - readme (#467)
wesleyboar May 21, 2024
58695ad
style(core-components): README nx format:write
wesleyboar May 21, 2024
f712da1
Merge branch 'main' into epic/TUP-700-core-components-node-pkg
wesleyboar Jul 10, 2024
e8a958c
Merge branch 'main' into epic/TUP-700-core-components-node-pkg
wesleyboar Sep 26, 2024
fd993c2
Merge branch 'main' into epic/TUP-700-core-components-node-pkg
wesleyboar Oct 18, 2024
bb8571d
feat: TUP-700 @tacc/core-components - use, test, fix (#465)
wesleyboar Oct 18, 2024
607b2e9
fix(tup-cms): `build tup-ui` fails inside docker
wesleyboar Oct 18, 2024
2dd44c2
docs(core-components): Known Clients
wesleyboar Oct 21, 2024
f37ea4d
Merge branch 'main' into epic/TUP-700-core-components-node-pkg
wesleyboar Dec 10, 2024
58936ac
Merge branch 'main' into epic/TUP-700-core-components-node-pkg
wesleyboar Dec 17, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,19 @@ This project was generated using [Nx](https://nx.dev).
The TUP dashboard is accessed at http://localhost:8000/portal.
To bring containers down after development, run `npx nx down tup-cms`.

<!--

Other useful commands:

- `npx nx serve core-components` to run a demo of the library for the core components.
- `npx nx build core-components` to create a distributable library for the core components.

-->

## Contributing

To contribute, first read [How to Contirbute](./docs/contributing.md).

---

<!-- NX -->

<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="450"></p>

🔎 **Smart, Fast and Extensible Build System**
Expand Down
2 changes: 1 addition & 1 deletion apps/tup-cms/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM node:20 as node_build
FROM --platform=linux/amd64 node:20 as node_build
COPY package.json package-lock.json /code/
WORKDIR /code
RUN npm ci
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import React, { useCallback, useMemo } from 'react';
import useWizardValues, { UIWizardProvider } from './useWizardValues';
import { UIWizardStep, UIWizardSchema, UIWizardExtra } from '.';
import { Wizard, WizardStep } from '@tacc/core-wrappers';
import { Wizard, WizardStep } from '@tacc/core-components';
import wizardSteps from './steps';

export const UIPatternsComplexWizardRender: React.FC<{
Expand All @@ -26,7 +26,7 @@ export const UIPatternsComplexWizardRender: React.FC<{
[add]
);

// Map Array of UIWizardSteps into an array of @tacc/core-wrappers/WizardStep
// Map Array of UIWizardSteps into an array of @tacc/core-components/WizardStep
const steps: Array<WizardStep<UIWizardSchema>> = useMemo(() => {
return wizardSteps.map((jobStep) => {
const { generateInitialValues, validateThunk, ...stepProps } = jobStep;
Expand Down
2 changes: 1 addition & 1 deletion apps/ui-patterns/src/app/UIPatternsComplexWizard/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export type InitialValueGenerator = (hookValues: {
extra: UIWizardExtra;
}) => Partial<UIWizardSchema>;

// An adapter type for mapping additional values to @tacc/core-wrappers/Wizard
// An adapter type for mapping additional values to @tacc/core-coponents/Wizard
export type UIWizardStep = {
id: string;
name: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import React, { useCallback, useState, useMemo } from 'react';
import * as Yup from 'yup';
import { UIWizardStep, UIWizardSchema, InitialValueGenerator } from '..';
import { Button } from '@tacc/core-components';
import { SubmitWrapper } from '@tacc/core-wrappers';
import { SubmitWrapper } from '@tacc/core-components';
import { validationSchema as stepOneValidationSchema } from './StepOne';
import { validationSchema as stepTwoValidationSchema } from './StepTwo';
import { validationSchema as stepThreeValidationSchema } from './StepThree';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
import { FormikInput } from '@tacc/core-wrappers';
import { FormikInput } from '@tacc/core-components';
import * as Yup from 'yup';
import { UIWizardStep, useWizardValues, InitialValueGenerator } from '..';
import { Field } from 'formik';

export const StepOne: React.FC = () => {
const { extra } = useWizardValues();
return (
<div>
<h2>Step One: Extra value two is {extra.extraTwo}</h2>
<FormikInput
<Field
component={FormikInput}
name="fieldOne"
required={true}
label="Field One"
description="The first form field"
/>
<FormikInput
<Field
component={FormikInput}
name="fieldTwo"
required={false}
label="Field Two"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
import React from 'react';
import { FormGroup } from 'reactstrap';
import { Collapse, Button } from '@tacc/core-components';
import { FieldArray, useFormikContext, FieldArrayRenderProps } from 'formik';
import { FormikInput, FormikCheck } from '@tacc/core-wrappers';
import {
FieldArray,
useFormikContext,
FieldArrayRenderProps,
Field,
} from 'formik';
import { FormikInput, FormikCheck } from '@tacc/core-components';
import * as Yup from 'yup';
import fieldArrayStyles from './FieldArray.module.css';
import {
Expand Down Expand Up @@ -34,13 +39,15 @@ const UIWizardComplexFieldRender: React.FC<UIWizardComplexFieldRenderProps> = ({
note="more values inside"
className={fieldArrayStyles.item}
>
<FormikInput
<Field
component={FormikInput}
name={`${innerKey}.name`}
label="Name"
required={true}
description="Name field of this object"
/>
<FormikCheck
<Field
component={FormikCheck}
name={`${innerKey}.include`}
label="Include"
required={false}
Expand Down Expand Up @@ -114,7 +121,8 @@ const OuterItemRender: React.FC<FieldArrayOfArraysRenderProps> = ({
title={`Field Array ${outerIndex}`}
className={fieldArrayStyles.item}
>
<FormikInput
<Field
component={FormikInput}
name={`fieldArrayOfArrays.${outerIndex}.name`}
label="Name"
required={true}
Expand Down
15 changes: 11 additions & 4 deletions apps/ui-patterns/src/app/UIPatternsComplexWizard/steps/StepTwo.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,13 @@ import React from 'react';
import { Button } from '@tacc/core-components';
import fieldArrayStyles from './FieldArray.module.css';
import { Collapse } from '@tacc/core-components';
import { FieldArray, useFormikContext, FieldArrayRenderProps } from 'formik';
import { FormikInput, FormikCheck } from '@tacc/core-wrappers';
import {
FieldArray,
useFormikContext,
FieldArrayRenderProps,
Field,
} from 'formik';
import { FormikInput, FormikCheck } from '@tacc/core-components';
import {
UIWizardStep,
UIWizardComplexField,
Expand Down Expand Up @@ -37,13 +42,15 @@ const UIWizardComplexFieldRender: React.FC<UIWizardComplexFieldProps> = ({
note="more values inside"
className={fieldArrayStyles.item}
>
<FormikInput
<Field
component={FormikInput}
name={`fieldArray.${index}.name`}
label="Name"
required={true}
description="Name field of this object"
/>
<FormikCheck
<Field
component={FormikCheck}
name={`fieldArray.${index}.include`}
label="Include"
required={false}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

import React, { useContext } from 'react';
import { UIWizardSchema, UIWizardExtra } from '.';
import { withBuilder } from '@tacc/core-wrappers';
import { withBuilder } from '@tacc/core-components';

// A React context for the external values
const UIWizardContext = React.createContext<UIWizardExtra>({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import React, { useCallback } from 'react';
import { UIWizardSchema } from '.';
import { UIWizardProvider, useWizardValues } from '.';
import { Wizard } from '@tacc/core-wrappers';
import { Wizard } from '@tacc/core-components';
import wizardSteps from './steps';

const UIPatternsWizardRender: React.FC = () => {
Expand Down
4 changes: 2 additions & 2 deletions apps/ui-patterns/src/app/UIPatternsWizard/steps/LastStep.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import React, { useCallback, useState, useMemo } from 'react';
import * as Yup from 'yup';
import { UIWizardSchema, useWizardValues } from '..';
import { Button } from '@tacc/core-components';
import { SubmitWrapper } from '@tacc/core-wrappers';
import { WizardStep } from '@tacc/core-wrappers';
import { SubmitWrapper } from '@tacc/core-components';
import { WizardStep } from '@tacc/core-components';
import { validationSchema as stepOneValidationSchema } from './StepOne';
import { validationSchema as stepTwoValidationSchema } from './StepTwo';
import { validationSchema as stepThreeValidationSchema } from './StepThree';
Expand Down
11 changes: 7 additions & 4 deletions apps/ui-patterns/src/app/UIPatternsWizard/steps/StepOne.tsx
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
import { FormikInput } from '@tacc/core-wrappers';
import { WizardStep } from '@tacc/core-wrappers';
import { FormikInput } from '@tacc/core-components';
import { WizardStep } from '@tacc/core-components';
import * as Yup from 'yup';
import { useWizardValues, UIWizardSchema } from '..';
import { Field } from 'formik';

export const StepOne: React.FC = () => {
return (
<div>
<h2>Step One</h2>
<FormikInput
<Field
component={FormikInput}
name="fieldOne"
required={true}
label="Name"
description="The first form field"
/>
<FormikInput
<Field
component={FormikInput}
name="fieldTwo"
required={false}
label="Description"
Expand Down
8 changes: 5 additions & 3 deletions apps/ui-patterns/src/app/UIPatternsWizard/steps/StepThree.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
import { FormikInput } from '@tacc/core-wrappers';
import { WizardStep } from '@tacc/core-wrappers';
import { FormikInput } from '@tacc/core-components';
import { WizardStep } from '@tacc/core-components';
import * as Yup from 'yup';
import { useWizardValues, UIWizardSchema } from '..';
import { Field } from 'formik';

export const StepThree: React.FC = () => {
return (
<div>
<h2>Step Three</h2>
<FormikInput
<Field
component={FormikInput}
name="fieldFour"
required={true}
label="Field Four"
Expand Down
8 changes: 5 additions & 3 deletions apps/ui-patterns/src/app/UIPatternsWizard/steps/StepTwo.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
import { FormikInput } from '@tacc/core-wrappers';
import { WizardStep } from '@tacc/core-wrappers';
import { FormikInput } from '@tacc/core-components';
import { WizardStep } from '@tacc/core-components';
import * as Yup from 'yup';
import { useWizardValues, UIWizardSchema } from '..';
import { Field } from 'formik';

export const StepTwo: React.FC = () => {
return (
<div>
<h2>Step Two</h2>
<FormikInput
<Field
component={FormikInput}
name="fieldThree"
required={true}
label="Field Three"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
*/

import { UIWizardSchema } from '.';
import { withBuilder } from '@tacc/core-wrappers';
import { withBuilder } from '@tacc/core-components';

// Use the withBuilder Higher Order Component to generate a context and provider
const { useBuilderContext, Provider } = withBuilder<UIWizardSchema>();
Expand Down
4 changes: 4 additions & 0 deletions libs/core-components/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# See http://help.github.com/ignore-files/ for more about ignoring files.

# compiled output
dist
20 changes: 20 additions & 0 deletions libs/core-components/.storybook/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import type { StorybookConfig } from '@storybook/react-vite';

const config: StorybookConfig = {
stories: ['../src/lib/**/*.stories.@(js|jsx|ts|tsx|mdx)'],
addons: ['@storybook/addon-essentials'],
framework: {
name: '@storybook/react-vite',
options: {
builder: {
viteConfigPath: 'libs/core-components/vite.config.ts',
},
},
},
};

export default config;

// To customize your Vite configuration you can use the viteFinal field.
// Check https://storybook.js.org/docs/react/builders/vite#configuration
// and https://nx.dev/recipes/storybook/custom-builder-configs
4 changes: 4 additions & 0 deletions libs/core-components/.storybook/preview.global.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/* https://tacc-main.atlassian.net/wiki/x/hRlv */
@import url('https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css') layer(foundation);
@import url('@tacc/core-styles/dist/core-styles.base.css') layer(base);
@import url('@tacc/core-styles/dist/core-styles.portal.css') layer(base);
1 change: 1 addition & 0 deletions libs/core-components/.storybook/preview.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import './preview.global.css';
Loading
Loading