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: move ID utilities to react-uid #142

Merged
merged 1 commit into from Jan 15, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/accordion/package.json
Expand Up @@ -18,7 +18,8 @@
},
"types": "dist/typings/index.d.ts",
"dependencies": {
"@zendeskgarden/container-utilities": "^0.3.0"
"@zendeskgarden/container-utilities": "^0.3.0",
"react-uid": "^2.2.0"
},
"peerDependencies": {
"prop-types": "^15.6.1",
Expand Down
5 changes: 3 additions & 2 deletions packages/accordion/src/useAccordion.ts
Expand Up @@ -6,9 +6,9 @@
*/

import { useState, HTMLProps } from 'react';
import { useUIDSeed } from 'react-uid';
import {
composeEventHandlers,
generateId,
KEY_CODES,
getControlledValue
} from '@zendeskgarden/container-utilities';
Expand Down Expand Up @@ -55,7 +55,8 @@ export function useAccordion({
expandable = true,
collapsible = true
}: IUseAccordionProps = {}): IUseAccordionReturnValue {
const [prefix] = useState<string>(idPrefix || generateId('garden-accordion-container'));
const seed = useUIDSeed();
const [prefix] = useState<string>(idPrefix || seed(`accordion_${PACKAGE_VERSION}`));
const TRIGGER_ID = `${prefix}--trigger`;
const PANEL_ID = `${prefix}--panel`;
const [expandedState, setExpandedState] = useState<number[]>(expandedSections || []);
Expand Down
2 changes: 1 addition & 1 deletion packages/field/package.json
Expand Up @@ -18,7 +18,7 @@
},
"types": "dist/typings/index.d.ts",
"dependencies": {
"@zendeskgarden/container-utilities": "^0.3.0"
"react-uid": "^2.2.0"
},
"peerDependencies": {
"prop-types": "^15.6.1",
Expand Down
5 changes: 3 additions & 2 deletions packages/field/src/useField.ts
Expand Up @@ -6,7 +6,7 @@
*/

import { useState } from 'react';
import { generateId } from '@zendeskgarden/container-utilities';
import { useUIDSeed } from 'react-uid';

export interface IUseFieldPropGetters {
getHintProps: <T>(options?: T) => T & React.HTMLProps<any>;
Expand All @@ -18,7 +18,8 @@ export interface IUseFieldPropGetters {
}

export function useField(idPrefix?: string): IUseFieldPropGetters {
const [prefix] = useState(idPrefix || generateId('garden-field-container'));
const seed = useUIDSeed();
const [prefix] = useState(idPrefix || seed(`field_${PACKAGE_VERSION}`));
const inputId = `${prefix}--input`;
const labelId = `${prefix}--label`;
const hintId = `${prefix}--hint`;
Expand Down
7 changes: 3 additions & 4 deletions packages/field/stories.tsx
Expand Up @@ -6,12 +6,11 @@
*/

import React from 'react';

import { uid } from 'react-uid';
import { storiesOf } from '@storybook/react';
import { withKnobs, text } from '@storybook/addon-knobs';

import { FieldContainer, useField } from './src';
import { generateId } from '@zendeskgarden/container-utilities';

storiesOf('Field Container', module)
.addDecorator(withKnobs)
Expand All @@ -30,10 +29,10 @@ storiesOf('Field Container', module)
);
};

return <Field id={text('id', generateId())} />;
return <Field id={text('id', uid({ name: 'useField' }))} />;
})
.add('FieldContainer', () => (
<FieldContainer id={text('id', generateId())}>
<FieldContainer id={text('id', uid({ name: 'FieldContainer' }))}>
{({ getLabelProps, getInputProps, getHintProps }) => (
<>
<label {...getLabelProps()}>Accessible Native Input</label>
Expand Down
3 changes: 2 additions & 1 deletion packages/modal/package.json
Expand Up @@ -19,7 +19,8 @@
"types": "dist/typings/index.d.ts",
"dependencies": {
"@zendeskgarden/container-focusjail": "^1.2.3",
"@zendeskgarden/container-utilities": "^0.3.0"
"@zendeskgarden/container-utilities": "^0.3.0",
"react-uid": "^2.2.0"
},
"peerDependencies": {
"prop-types": "^15.6.1",
Expand Down
6 changes: 4 additions & 2 deletions packages/modal/src/useModal.ts
Expand Up @@ -6,7 +6,8 @@
*/

import { useState } from 'react';
import { composeEventHandlers, generateId, KEY_CODES } from '@zendeskgarden/container-utilities';
import { useUIDSeed } from 'react-uid';
import { composeEventHandlers, KEY_CODES } from '@zendeskgarden/container-utilities';
import { useFocusJail } from '@zendeskgarden/container-focusjail';

export interface IUseModalProps {
Expand All @@ -29,7 +30,8 @@ export interface IUseModalReturnValue {
export function useModal(
{ onClose, modalRef, id: _id, focusOnMount, environment }: IUseModalProps = {} as any
): IUseModalReturnValue {
const [idPrefix] = useState(_id || generateId('garden-modal-container'));
const seed = useUIDSeed();
const [idPrefix] = useState(_id || seed(`modal_${PACKAGE_VERSION}`));
const titleId = `${idPrefix}--title`;
const contentId = `${idPrefix}--content`;

Expand Down
2 changes: 1 addition & 1 deletion packages/tabs/package.json
Expand Up @@ -19,7 +19,7 @@
"types": "dist/typings/index.d.ts",
"dependencies": {
"@zendeskgarden/container-selection": "^1.2.6",
"@zendeskgarden/container-utilities": "^0.3.0"
"react-uid": "^2.2.0"
},
"peerDependencies": {
"prop-types": "^15.6.1",
Expand Down
5 changes: 3 additions & 2 deletions packages/tabs/src/useTabs.ts
Expand Up @@ -6,13 +6,13 @@
*/

import { useState } from 'react';
import { useUIDSeed } from 'react-uid';
import {
useSelection,
IGetItemPropsOptions,
IUseSelectionState,
IUseSelectionProps
} from '@zendeskgarden/container-selection';
import { generateId } from '@zendeskgarden/container-utilities';

interface IGetTabProps<Item> extends IGetItemPropsOptions<Item> {
index: number;
Expand Down Expand Up @@ -52,7 +52,8 @@ export function useTabs<Item = any>({
defaultSelectedIndex: 0,
...options
});
const [_id] = useState(idPrefix || generateId('garden-tabs-container'));
const seed = useUIDSeed();
const [_id] = useState(idPrefix || seed(`tabs_${PACKAGE_VERSION}`));
const PANEL_ID = `${_id}--panel`;
const TAB_ID = `${_id}--tab`;

Expand Down
3 changes: 2 additions & 1 deletion packages/tooltip/package.json
Expand Up @@ -18,7 +18,8 @@
},
"types": "dist/typings/index.d.ts",
"dependencies": {
"@zendeskgarden/container-utilities": "^0.3.0"
"@zendeskgarden/container-utilities": "^0.3.0",
"react-uid": "^2.2.0"
},
"peerDependencies": {
"prop-types": "^15.6.1",
Expand Down
6 changes: 4 additions & 2 deletions packages/tooltip/src/useTooltip.ts
Expand Up @@ -6,7 +6,8 @@
*/

import { useState, useEffect, useRef } from 'react';
import { composeEventHandlers, generateId, KEY_CODES } from '@zendeskgarden/container-utilities';
import { useUIDSeed } from 'react-uid';
import { composeEventHandlers, KEY_CODES } from '@zendeskgarden/container-utilities';

export interface IUseTooltipProps {
delayMilliseconds?: number;
Expand All @@ -28,7 +29,8 @@ export const useTooltip = ({
isVisible
}: IUseTooltipProps = {}): IUseTooltipReturnValue => {
const [visibility, setVisibility] = useState(isVisible);
const [_id] = useState(id || generateId('garden-tooltip-container'));
const seed = useUIDSeed();
const [_id] = useState(id || seed(`tooltip_${PACKAGE_VERSION}`));
const isMounted = useRef(false);

let openTooltipTimeoutId: number | undefined;
Expand Down
2 changes: 1 addition & 1 deletion packages/utilities/src/utils/IdManager.ts
Expand Up @@ -18,7 +18,7 @@ export function generateId(prefix = 'garden') {

/**
* This is only used in tests... Could be useful in SSR?
* @param {Number} num The number to set the idCountry to
* @param {Number} num The number to set the idCounter to
*/
export function setIdCounter(num: number) {
idCounter = num;
Expand Down