Skip to content

Commit

Permalink
PR Feedback: Shorter FlashMessagesLogic type names
Browse files Browse the repository at this point in the history
  • Loading branch information
cee-chen committed Aug 26, 2020
1 parent ec50b60 commit adc814e
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import React, { Fragment } from 'react';
import { useValues } from 'kea';
import { EuiCallOut, EuiCallOutProps, EuiSpacer } from '@elastic/eui';

import { FlashMessagesLogic, IFlashMessagesLogicValues } from './flash_messages_logic';
import { FlashMessagesLogic, IFlashMessagesValues } from './flash_messages_logic';

const FLASH_MESSAGE_TYPES = {
success: { color: 'success' as EuiCallOutProps['color'], icon: 'check' },
Expand All @@ -18,7 +18,7 @@ const FLASH_MESSAGE_TYPES = {
};

export const FlashMessages: React.FC = ({ children }) => {
const { messages } = useValues(FlashMessagesLogic) as IFlashMessagesLogicValues;
const { messages } = useValues(FlashMessagesLogic) as IFlashMessagesValues;

// If we have no messages to display, do not render the element at all
if (!messages.length) return null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ export interface IFlashMessage {
description?: ReactNode;
}

export interface IFlashMessagesLogicValues {
export interface IFlashMessagesValues {
messages: IFlashMessage[];
queuedMessages: IFlashMessage[];
historyListener: Function | null;
}
export interface IFlashMessagesLogicActions {
export interface IFlashMessagesActions {
setFlashMessages(messages: IFlashMessage | IFlashMessage[]): void;
clearFlashMessages(): void;
setQueuedMessages(messages: IFlashMessage | IFlashMessage[]): void;
Expand All @@ -34,15 +34,15 @@ const convertToArray = (messages: IFlashMessage | IFlashMessage[]) =>
!Array.isArray(messages) ? [messages] : messages;

export const FlashMessagesLogic = kea({
actions: (): IFlashMessagesLogicActions => ({
actions: (): IFlashMessagesActions => ({
setFlashMessages: (messages) => ({ messages: convertToArray(messages) }),
clearFlashMessages: () => null,
setQueuedMessages: (messages) => ({ messages: convertToArray(messages) }),
clearQueuedMessages: () => null,
listenToHistory: (history) => history,
setHistoryListener: (historyListener) => ({ historyListener }),
}),
reducers: (): TKeaReducers<IFlashMessagesLogicValues, IFlashMessagesLogicActions> => ({
reducers: (): TKeaReducers<IFlashMessagesValues, IFlashMessagesActions> => ({
messages: [
[],
{
Expand All @@ -64,7 +64,7 @@ export const FlashMessagesLogic = kea({
},
],
}),
listeners: ({ values, actions }): Partial<IFlashMessagesLogicActions> => ({
listeners: ({ values, actions }): Partial<IFlashMessagesActions> => ({
listenToHistory: (history) => {
// On React Router navigation, clear previous flash messages and load any queued messages
const unlisten = history.listen(() => {
Expand All @@ -81,7 +81,7 @@ export const FlashMessagesLogic = kea({
if (removeHistoryListener) removeHistoryListener();
},
}),
} as IKeaParams<IFlashMessagesLogicValues, IFlashMessagesLogicActions>) as IKeaLogic<
IFlashMessagesLogicValues,
IFlashMessagesLogicActions
} as IKeaParams<IFlashMessagesValues, IFlashMessagesActions>) as IKeaLogic<
IFlashMessagesValues,
IFlashMessagesActions
>;
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ import { History } from 'history';

import {
FlashMessagesLogic,
IFlashMessagesLogicValues,
IFlashMessagesLogicActions,
IFlashMessagesValues,
IFlashMessagesActions,
} from './flash_messages_logic';

interface IFlashMessagesProviderProps {
history: History;
}

export const FlashMessagesProvider: React.FC<IFlashMessagesProviderProps> = ({ history }) => {
const { historyListener } = useValues(FlashMessagesLogic) as IFlashMessagesLogicValues;
const { listenToHistory } = useActions(FlashMessagesLogic) as IFlashMessagesLogicActions;
const { historyListener } = useValues(FlashMessagesLogic) as IFlashMessagesValues;
const { listenToHistory } = useActions(FlashMessagesLogic) as IFlashMessagesActions;

useEffect(() => {
if (!historyListener) listenToHistory(history);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export { FlashMessages } from './flash_messages';
export {
FlashMessagesLogic,
IFlashMessage,
IFlashMessagesLogicValues,
IFlashMessagesLogicActions,
IFlashMessagesValues,
IFlashMessagesActions,
} from './flash_messages_logic';
export { FlashMessagesProvider } from './flash_messages_provider';

0 comments on commit adc814e

Please sign in to comment.