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.

Sign up for GitHub

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

Jump to bottom

Re export utils to consumers #4504

Closed
wants to merge 2 commits into from
Closed

Re export utils to consumers #4504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05ae1ee
rename custom-element.ts -> createComponent.ts
keithamus Apr 15, 2024
10f46cf
re-export utils to consumers
keithamus Apr 15, 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
8 changes: 8 additions & 0 deletions packages/react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@
"import": "./lib-esm/index.js",
"require": "./lib/index.js"
},
"./utils/*": {
"import": "./lib-esm/utils/*",
"require": "./lib/utils/*"
},
"./utils": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Random question, is there an advantage to these being in their own entry point compared to being re-exported from the main entry point?

"import": "./lib-esm/utils/index.js",
"require": "./lib/utils/index.js"
},
"./experimental": {
"import": "./lib-esm/experimental/index.js",
"require": "./lib/experimental/index.js"
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/RelativeTime/RelativeTime.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React from 'react'
import {RelativeTimeElement} from '@github/relative-time-element'
import type {ComponentProps} from '../utils/types'
import {createComponent} from '../utils/custom-element'
import {createComponent} from '../utils/customElement'
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

renamed this to fit the name of the export


const RelativeTimeComponent = createComponent(RelativeTimeElement, 'relative-time')

Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/drafts/TabPanels/TabPanels.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import React from 'react'
import styled from 'styled-components'
import {get} from '../../constants'
import {TabContainerElement} from '@github/tab-container-element'
import {createComponent} from '../../utils/custom-element'
import {createComponent} from '../../utils/customElement'
import sx, {type SxProp} from '../../sx'
import type {ComponentProps} from '../../utils/types'
import getGlobalFocusStyles from '../../internal/utils/getGlobalFocusStyles'
Expand Down
0 packages/react/src/utils/custom-element.ts → packages/react/src/utils/createComponent.ts
View file
Open in desktop
File renamed without changes.
21 changes: 21 additions & 0 deletions packages/react/src/utils/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import isNumeric from './isNumeric'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just wanted to check-in, are the exported utilities in this file ones that currently being used externally? If possible, it'd be great to limit what we export publicly to reduce our surface area.

import useIsomorpyhicLayoutEffect from './useIsomorphicLayoutEffect'

export {isNumeric, useIsomorpyhicLayoutEffect}

export * from './createComponent'
export * from './defaultSxProp'
export * from './deprecate'
export * from './environment'
export * from './form-story-helpers'
export * from './getBreakpointDeclarations'
export * from './invariant'
export * from './layout'
export * from './scroll'
export * from './ssr'
export * from './theme'
export * from './use-force-update'
export * from './warning'

export type * from './types'
export type {ForwardRefComponent, OwnProps, IntrinsicElement} from './polymorphic'
Loading