Skip to content

Commit

Permalink
feat(OO): Add an edit button to the toolbar in place of the FabButton
Browse files Browse the repository at this point in the history
And no longer display the FabButton in Desktop mode
  • Loading branch information
Merkur39 committed Jan 28, 2025
1 parent 6f351a9 commit a6910ec
Show file tree
Hide file tree
Showing 6 changed files with 163 additions and 7 deletions.
8 changes: 8 additions & 0 deletions src/locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -663,6 +663,14 @@
"actions": {
"edit": "Edit",
"validate": "Validate"
},
"tooltip": {
"title": "Edit document",
"text": "The document is currently read-only. You can modify it by clicking here.",
"actions": {
"ok": "Ok",
"hide": "Do not display"
}
}
},
"Migration": {
Expand Down
8 changes: 8 additions & 0 deletions src/locales/fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -664,6 +664,14 @@
"actions": {
"edit": "Modifier",
"validate": "Valider"
},
"tooltip": {
"title": "Modifier le document",
"text": "Le document est actuellement en lecture seule, Vous pouvez le modifier en cliquant ici.",
"actions": {
"ok": "Ok",
"hide": "Ne plus afficher"
}
}
},
"Migration": {
Expand Down
124 changes: 124 additions & 0 deletions src/modules/views/OnlyOffice/Toolbar/EditButton.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
import React, { useState } from 'react'
import { useNavigate } from 'react-router-dom'

import { useClient, useQuery, Q, isQueryLoading } from 'cozy-client'
import Buttons from 'cozy-ui/transpiled/react/Buttons'
import Icon from 'cozy-ui/transpiled/react/Icon'
import LightbulbIcon from 'cozy-ui/transpiled/react/Icons/Lightbulb'
import RenameIcon from 'cozy-ui/transpiled/react/Icons/Rename'
import Tooltip from 'cozy-ui/transpiled/react/Tooltip'
import Typography from 'cozy-ui/transpiled/react/Typography'
import useBreakpoints from 'cozy-ui/transpiled/react/providers/Breakpoints'
import { useI18n } from 'cozy-ui/transpiled/react/providers/I18n'
import { makeStyles } from 'cozy-ui/transpiled/react/styles'

import { DOCTYPE_FILES_SETTINGS } from 'lib/doctypes'
import { useOnlyOfficeContext } from 'modules/views/OnlyOffice/OnlyOfficeProvider'
import { canWriteOfficeDocument } from 'modules/views/OnlyOffice/helpers'
import { getAppSettingQuery } from 'queries'

const useStyle = makeStyles({
popper: {
pointerEvents: 'auto',
'& .actions-tooltip': {
display: 'flex',
justifyContent: 'flex-end',
marginTop: '0.5rem',
'& > button': {
color: 'var(--white)'
}
}
},
tooltip: {
backgroundColor: 'var(--primaryColor)'
},
arrow: {
color: 'var(--primaryColor)'
}
})

export const EditButton = () => {
const navigate = useNavigate()
const classes = useStyle()
const client = useClient()
const { t } = useI18n()
const { isMobile } = useBreakpoints()
const [showTooltip, setShowTooltip] = useState(true)

const { editorMode, setEditorMode } = useOnlyOfficeContext()

const { data: settings, ...appSettingsQueryResult } = useQuery(
getAppSettingQuery.definition,
getAppSettingQuery.options
)
const hideOOEditTooltip = settings?.[0]?.hideOOEditTooltip
const openTooltip = isQueryLoading(appSettingsQueryResult)
? false
: !hideOOEditTooltip && editorMode === 'view' && canWriteOfficeDocument()

const handleClick = () => {
if (canWriteOfficeDocument()) {
setEditorMode(editorMode === 'view' ? 'edit' : 'view')
} else {
navigate('./paywall')
}
}

const closeTooltip = () => {
setShowTooltip(false)
}

const handleTooltip = async () => {
const { data } = await client.query(Q(DOCTYPE_FILES_SETTINGS))
const settings = data?.[0] || {}
await client.save({
...settings,
_type: DOCTYPE_FILES_SETTINGS,
hideOOEditTooltip: true
})
}

if (isMobile) {
return null
}

return (
<Tooltip
open={showTooltip && openTooltip}
classes={classes}
title={
<>
<div className="u-flex u-flex-items-center u-mb-half">
<Icon icon={LightbulbIcon} className="u-mr-half" />
<Typography variant="h6" color="inherit">
{t('OnlyOffice.tooltip.title')}
</Typography>
</div>
<Typography variant="body2" color="inherit">
{t('OnlyOffice.tooltip.text')}
</Typography>
<div className="actions-tooltip">
<Buttons
onClick={handleTooltip}
variant="text"
label={t('OnlyOffice.tooltip.actions.hide')}
/>
<Buttons
onClick={closeTooltip}
variant="text"
label={t('OnlyOffice.tooltip.actions.ok')}
/>
</div>
</>
}
>
<Buttons
className="u-ml-half"
onClick={handleClick}
disabled={editorMode === 'edit'}
startIcon={<Icon icon={RenameIcon} />}
label={t('OnlyOffice.actions.edit')}
/>
</Tooltip>
)
}
8 changes: 7 additions & 1 deletion src/modules/views/OnlyOffice/Toolbar/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { useRedirectLink } from 'hooks/useRedirectLink'
import PublicToolbarMoreMenu from 'modules/public/PublicToolbarMoreMenu'
import { useOnlyOfficeContext } from 'modules/views/OnlyOffice/OnlyOfficeProvider'
import BackButton from 'modules/views/OnlyOffice/Toolbar/BackButton'
import { EditButton } from 'modules/views/OnlyOffice/Toolbar/EditButton'
import FileIcon from 'modules/views/OnlyOffice/Toolbar/FileIcon'
import FileName from 'modules/views/OnlyOffice/Toolbar/FileName'
import HomeIcon from 'modules/views/OnlyOffice/Toolbar/HomeIcon'
Expand Down Expand Up @@ -98,7 +99,12 @@ const Toolbar = ({ sharingInfos }) => {
<PublicToolbarMoreMenu files={[fileWithPath]} actions={actions} />
)}

{!isPublic && isEditorReady && <Sharing fileWithPath={fileWithPath} />}
{!isPublic && isEditorReady && (
<>
<Sharing fileWithPath={fileWithPath} />
<EditButton />
</>
)}
</>
)
}
Expand Down
7 changes: 3 additions & 4 deletions src/modules/views/OnlyOffice/View.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ const forceIframeHeight = value => {
const View = ({ id, apiUrl, docEditorConfig }) => {
const [isError, setIsError] = useState(false)

const { isEditorReady, isReadOnly, isTrashed, isEditorModeView } =
useOnlyOfficeContext()
const { isEditorReady, isReadOnly, isTrashed } = useOnlyOfficeContext()
const { isMobile, isDesktop } = useBreakpoints()

const initEditor = useCallback(() => {
Expand Down Expand Up @@ -54,11 +53,11 @@ const View = ({ id, apiUrl, docEditorConfig }) => {
}, [isEditorReady])

const showReadOnlyFab =
isMobile &&
isEditorReady &&
!isReadOnly &&
!isTrashed &&
isOfficeEditingEnabled(isDesktop) &&
(isMobile || isEditorModeView)
isOfficeEditingEnabled(isDesktop)

if (isError) return <Error />

Expand Down
15 changes: 13 additions & 2 deletions src/queries/index.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
import CozyClient, { Q, QueryDefinition } from 'cozy-client'
import CozyClient, { Q, QueryDefinition, fetchPolicies } from 'cozy-client'

Check failure on line 1 in src/queries/index.ts

View workflow job for this annotation

GitHub Actions / Build and publish

'fetchPolicies' is defined but never used
import { QueryOptions } from 'cozy-client/types/types'

import { SHARED_DRIVES_DIR_ID, TRASH_DIR_ID } from 'constants/config'
import { DOCTYPE_FILES_ENCRYPTION, DOCTYPE_ALBUMS } from 'lib/doctypes'
import {
DOCTYPE_FILES_ENCRYPTION,
DOCTYPE_ALBUMS,
DOCTYPE_FILES_SETTINGS
} from 'lib/doctypes'
import { formatFolderQueryId } from 'lib/queries'

export interface QueryConfig {
Expand Down Expand Up @@ -532,3 +536,10 @@ export const buildNextcloudTrashFolderQuery: QueryBuilder<
enabled: !!sourceAccount && !!path
}
})

export const getAppSettingQuery: QueryConfig = {
definition: () => Q(DOCTYPE_FILES_SETTINGS),
options: {
as: DOCTYPE_FILES_SETTINGS
}
}

0 comments on commit a6910ec

Please sign in to comment.