OWL
data_display
Settings Page
Odoo 19 OWL component — Settings Page (webclient)
Live preview
Interactive
Source excerpt
web/static/src/webclient/settings_form_view/settings/settings_page.js
import { ActionSwiper } from "@web/core/action_swiper/action_swiper";
import { Component, useState, useRef, useEffect } from "@odoo/owl";
import { browser } from "@web/core/browser/browser";
import { Deferred } from "@web/core/utils/concurrency";
export class SettingsPage extends Component {
static template = "web.SettingsPage";
static components = { ActionSwiper };
static props = {
modules: Array,
anchors: Array,
initialTab: { type: String, optional: 1 },
slots: Object,
};
setup() {
this.state = useState({
selectedTab: "",
search: this.env.searchState,
});
if (this.props.modules) {
let selectedTab = this.props.initialTab || this.props.modules[0].key;
if (browser.location.hash) {
const hash = browser.location.hash.substring(1);
if (this.props.modules.map((m) => m.key).includes(hash)) {
selectedTab = hash;
} else {
const plop = this.props.anchors.find((a) => a.settingId === hash);
if (plop) {
selectedTab = plop.app;
}
}
}
this.state.selectedTab = selectedTab;
}
this.settingsRef = useRef("settings");
this.settingsTabRef = useRef("settings_tab");
this.scrollMap = Object.create(null);
useEffect(
(settingsEl, currentTab) => {
if (!settingsEl) {
return;
}
const { scrollTop } = this.scrollMap[currentTab] || 0;
settingsEl.scrollTop = scrollTop;
this.tabChangeProm?.resolve();
},
() => [this.settingsRef.el, this.state.selectedTab]
);
}
getCurrentIndex() {
return this.props.modules.findIndex((object) => {
return object.key === this.state.selectedTab;
});
}
hasRightSwipe() {
return (
this.env.isSmall && this.state.search.value.length === 0 && this.getCurrentIndex() !== 0
);
}
hasLeftSwipe() {
return (
this.env.isSmall &&
this.state.search.value.length === 0 &&
this.getCurrentIndex() !== this.props.modules.length - 1
);
}
async onRightSwipe() {
this.tabChangeProm = new Deferred();
this.state.selectedTab = this.props.modules[this.getCurrentIndex() - 1].key;
await this.tabChangeProm;
this.scrollToSelectedTab();
}
async onLeftSwipe() {
this.tabChangeProm = new Deferred();
this.state.selectedTab = this.props.modules[this.getCurrentIndex() + 1].key;
await this.tabChangeProm;
this.scrollToSelectedTab();
}
scrollToSelectedTab() {
const key = this.state.selectedTab;
this.settingsTabRef.el
.querySelector(`[data-key='${key}']`)
.scrollIntoView({ behavior: "smooth", inline: "center", block: "nearest" });
}
onSettingTabClick(key) {
if (this.settingsRef.el) {
const { scrollTop } = this.settingsRef.el;
this.scrollMap[this.state.selectedTab] = { scrollTop };
}
this.state.selectedTab = key;
this.env.searchState.value = "";
}
}
Registry / API
- Registry name
SettingsPage- Category
—- Module
web- Slug
settings-page- Nav group
data_display