@popmenu/common-ui 0.16.0 → 0.17.0

package/build/components/AudioPlayer/AudioPlayer.d.ts

@@ -0,0 +1,3 @@
+import { FC } from 'react';
+import { AudioPlayerProps } from './AudioPlayerProps';
+export declare const AudioPlayer: FC<AudioPlayerProps>;

package/build/components/AudioPlayer/AudioPlayerProps.d.ts

@@ -0,0 +1,4 @@
+export interface AudioPlayerProps {
+    /** The URL of the audio to embed. */
+    src?: string;
+}

package/build/components/AudioPlayer/index.d.ts

@@ -0,0 +1,2 @@
+export { AudioPlayer as default } from './AudioPlayer';
+export { AudioPlayerProps } from './AudioPlayerProps';

package/build/components/AudioPlayer/util/audioPlayerReducer.d.ts

@@ -0,0 +1,11 @@
+import { PLAYBACK_STATES, CONTROL_LABELS, AudioPlayerState, AudioPlayerEvent, VOLUME_CONTROL_STATES } from './types';
+export declare const initialAudioPlayerState: {
+    playback: PLAYBACK_STATES;
+    volumeControls: VOLUME_CONTROL_STATES;
+    context: {
+        volume: number;
+        playbackButtonLabel: CONTROL_LABELS;
+        volumeButtonLabel: CONTROL_LABELS;
+    };
+};
+export declare const audioPlayerReducer: (state: AudioPlayerState, event: AudioPlayerEvent) => AudioPlayerState;

package/build/components/AudioPlayer/util/formatTime.d.ts

@@ -0,0 +1 @@
+export declare const formatTime: (time: number, remaning?: boolean) => string;

package/build/components/AudioPlayer/util/index.d.ts

@@ -0,0 +1,6 @@
+export { audioPlayerReducer, initialAudioPlayerState } from './audioPlayerReducer';
+export { usePlaybackIcon } from './usePlaybackIcon';
+export { useVolumeIcon } from './useVolumeIcon';
+export { formatTime } from './formatTime';
+export { setupAudioRef } from './setupAudioRef';
+export * from './types';

package/build/components/AudioPlayer/util/setupAudioRef.d.ts

@@ -0,0 +1,8 @@
+import { RefObject } from 'react';
+import { AudioPlayerEvent } from './types';
+interface Config {
+    audioRef: RefObject<HTMLAudioElement>;
+    send: (event: AudioPlayerEvent) => void;
+}
+export declare const setupAudioRef: (config: Config) => () => () => void;
+export {};

package/build/components/AudioPlayer/util/types.d.ts

@@ -0,0 +1,74 @@
+import { RefObject } from 'react';
+export declare enum AUDIO_PLAYER_EVENT_TYPES {
+    TOGGLE_PLAYBACK = "TOGGLE_PLAYBACK",
+    TOGGLE_VOLUME_CONTROL = "TOGGLE_VOLUME_CONTROL",
+    TOGGLE_MUTE = "TOGGLE_MUTE",
+    VOLUME_CHANGE = "VOLUME_CHANGE",
+    TIME_CHANGE = "TIME_CHANGE",
+    DURATION_CHANGE = "DURATION_CHANGE",
+    SET_TIME = "SET_TIME",
+    CAN_PLAY = "CAN_PLAY"
+}
+interface SetVolumeEvent {
+    type: AUDIO_PLAYER_EVENT_TYPES.VOLUME_CHANGE;
+    context: Pick<AudioPlayerExtendState, 'volume'>;
+}
+interface TogglePlaybackEvent {
+    type: AUDIO_PLAYER_EVENT_TYPES.TOGGLE_PLAYBACK;
+}
+interface ToggleVolumeControlEvent {
+    type: AUDIO_PLAYER_EVENT_TYPES.TOGGLE_VOLUME_CONTROL;
+}
+interface TimeChangeEvent {
+    type: AUDIO_PLAYER_EVENT_TYPES.TIME_CHANGE;
+    context: {
+        currentTime: number;
+    };
+}
+interface DurationChangeEvent {
+    type: AUDIO_PLAYER_EVENT_TYPES.DURATION_CHANGE;
+    context: {
+        duration: number;
+    };
+}
+interface ToggleMuteEvent {
+    type: AUDIO_PLAYER_EVENT_TYPES.TOGGLE_MUTE;
+}
+interface SetTimeEvent {
+    type: AUDIO_PLAYER_EVENT_TYPES.SET_TIME;
+    context: {
+        time: number;
+    };
+}
+interface CanPlayEvent {
+    type: AUDIO_PLAYER_EVENT_TYPES.CAN_PLAY;
+}
+export declare type AudioPlayerEvent = TogglePlaybackEvent | ToggleVolumeControlEvent | SetVolumeEvent | TimeChangeEvent | DurationChangeEvent | ToggleMuteEvent | SetTimeEvent | CanPlayEvent;
+export declare enum PLAYBACK_STATES {
+    NONE = "NONE",
+    PLAYABLE = "PLAYABLE",
+    PAUSED = "PAUSED",
+    PLAYING = "PLAYING"
+}
+export declare enum CONTROL_LABELS {
+    PAUSE = "PAUSE",
+    PLAY = "PLAY",
+    MUTE = "MUTE",
+    UNMUTE = "UNMUTE"
+}
+export declare enum VOLUME_CONTROL_STATES {
+    SHOW = "SHOW",
+    HIDE = "HIDE"
+}
+export interface AudioPlayerExtendState {
+    volume: number;
+    audioRef: RefObject<HTMLAudioElement>;
+    playbackButtonLabel: CONTROL_LABELS;
+    volumeButtonLabel: CONTROL_LABELS;
+}
+export interface AudioPlayerState {
+    playback: PLAYBACK_STATES;
+    volumeControls: VOLUME_CONTROL_STATES;
+    context: AudioPlayerExtendState;
+}
+export {};

package/build/components/AudioPlayer/util/usePlaybackIcon.d.ts

@@ -0,0 +1,2 @@
+import { AudioPlayerState } from './types';
+export declare const usePlaybackIcon: (state: AudioPlayerState) => string;

package/build/components/AudioPlayer/util/useVolumeIcon.d.ts

@@ -0,0 +1,2 @@
+import { AudioPlayerState } from './types';
+export declare const useVolumeIcon: (state: AudioPlayerState) => string;

package/build/components/index.d.ts

@@ -4,6 +4,7 @@ export { default as AccordionActions, AccordionActionsProps } from './AccordionA
 export { default as AccordionDetails, AccordionDetailsProps } from './AccordionDetails';
 export { default as AccordionSummary, AccordionSummaryProps } from './AccordionSummary';
 export { default as AppBar, AppBarProps } from './AppBar';
+export { default as AudioPlayer, AudioPlayerProps } from './AudioPlayer';
 export { default as Avatar, AvatarProps } from './Avatar';
 export { default as Badge, BadgeProps } from './Badge';
 export { default as Box, BoxProps } from './Box';