diff --git a/package.json b/package.json index 2fc807d0..5cad06f8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "openstack-uicore-foundation", - "version": "5.0.43", + "version": "5.0.44-beta.0", "description": "ui reactjs components for openstack marketing site", "main": "lib/openstack-uicore-foundation.js", "scripts": { diff --git a/readme.md b/readme.md index 2c50a158..d2d04c2f 100644 --- a/readme.md +++ b/readme.md @@ -11,6 +11,23 @@ import 'font-awesome/css/font-awesome.css'; import 'openstack-uicore-foundation/lib/css/components.css'; import 'sweetalert2/dist/sweetalert2.css'; +## Importing Components + +Prefer importing components from their individual paths rather than the +`openstack-uicore-foundation/lib/components` barrel: + +```js +import UploadInputV3 from 'openstack-uicore-foundation/lib/components/inputs/upload-input-v3'; +``` + +Components that pull in heavy 3rd-party dependencies (MUI, Stripe, +react-beautiful-dnd, etc.) are intentionally commented out of +`src/components/index.js` (see the `// these include 3rd party deps` block) +so that consumers who don't use them aren't forced to install those peer +dependencies just to import something unrelated from the barrel. These +components are only reachable via their individual path — a barrel import +will not resolve them. + ### Enviroment Variables * TIMEINTERVALSINCE1970_API_URL = URL used on clock component to get server time diff --git a/src/components/index.js b/src/components/index.js index f074b1c0..9eed75e4 100644 --- a/src/components/index.js +++ b/src/components/index.js @@ -5,7 +5,6 @@ export {default as DateTimePicker} from './inputs/datetimepicker' export {default as GroupedDropdown} from './inputs/grouped-dropdown' export {default as UploadInput} from './inputs/upload-input' export {default as UploadInputV2} from './inputs/upload-input-v2' -export {default as UploadInputV3} from './inputs/upload-input-v3' export {default as CompanyInput} from './inputs/company-input' export {default as PromocodeInput} from './inputs/promocode-input' export {default as SponsorInput} from './inputs/sponsor-input' @@ -135,6 +134,7 @@ export {MuiBaseCustomTheme} from './mui/MuiBaseCustomTheme' // export {default as TextEditorV2} from './inputs/editor-input-v2' // export {default as TextEditorV3} from './inputs/editor-input-v3' // export {default as CompanyInputV2} from './inputs/company-input-v2.js' +// export {default as UploadInputV3} from './inputs/upload-input-v3' // @mui/material, @mui/icons-material, @mui/x-date-pickers, spark-md5, dropzone, react-dropzone // export {default as MuiDndList} from './mui/dnd-list' // react-beautiful-dnd // export {default as MuiSortableTable} from './mui/sortable-table/mui-table-sortable' // react-beautiful-dnd // export {default as MuiStripePayment} from './mui/StripePayment' // @stripe/react-stripe-js, @stripe/stripe-js